tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDomainErrorPageInfo

Last updated: 2023-07-13 15:25:26

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API is used to query the custom error response to a domain name.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeDomainErrorPageInfo.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
ListenerId Yes String Listener ID
Domain Yes String Domain name

3. Output Parameters

Parameter Name Type Description
ErrorPageSet Array of DomainErrorPageInfo Configuration set of a custom error response
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 DescribeDomainErrorPageInfo

Input Example

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainErrorPageInfo
<Common request parameters>

{
    "Domain": "a.com",
    "ListenerId": "0"
}

Output Example

{
    "Response": {
        "RequestId": "8d9f4d84-b825-4a4f-8c4c-3c87c559c84c",
        "ErrorPageSet": [
            {
                "Body": "str",
                "Domain": "test.domain",
                "ClearHeaders": [
                    "MyClearHeader",
                    "MyClearHeader1"
                ],
                "ListenerId": "listener-23egjhxb",
                "ErrorNos": [
                    501,
                    502
                ],
                "Status": 1,
                "ErrorPageId": "errorPage-lhlnux1v",
                "NewErrorNo": 123,
                "SetHeaders": [
                    {
                        "HeaderName": "MyName",
                        "HeaderValue": "MyValue"
                    },
                    {
                        "HeaderName": "MyName1",
                        "HeaderValue": "MyValue1"
                    }
                ]
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.NotSupportProxyGroup This operation is not supported for connection groups.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy