Last updated: 2021-10-08 15:10:44

1. API Description

Domain name for API request:

This API is used to query the corresponding error response by a custom error ID.

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 parameter. The value used for this API: DescribeDomainErrorPageInfoByIds.
Version Yes String Common parameter. The value used for this API: 2018-05-29.
Region No String Common parameter. This parameter is not required for this API.
ErrorPageIds.N Yes Array of String List of custom error IDs. Up to 10 IDs are supported

3. Output Parameters

Parameter Name Type Description
ErrorPageSet Array of DomainErrorPageInfo Configuration set of custom error responses
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 DescribeDomainErrorPageInfoByIds

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "8d9f4d84-b825-4a4f-8c4c-3c87c559c84c",
    "ErrorPageSet": [
        "Body": "sx",
        "Status": 0,
        "Domain": "test.domain",
        "ClearHeaders": [
        "ListenerId": "listener-23egjhxb",
        "ErrorNos": [
        "ErrorPageId": "errorPage-lhlnux1v",
        "NewErrorNo": 4123,
        "SetHeaders": [
            "HeaderName": "MyName",
            "HeaderValue": "MyValue"
            "HeaderName": "MyName1",
            "HeaderValue": "MyValue1"

5. Developer Resources


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
FailedOperation Operation failed.
FailedOperation.NotSupportProxyGroup This operation is not supported for connection groups.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.