tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCustomErrorPages

Last updated: 2024-10-11 15:52:36

1. API Description

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

This API is used to query the custom response page list.

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: DescribeCustomErrorPages.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Zone ID.
Filters.N No Array of AdvancedFilter Filter criteria. The maximum number of Filters.Values is 20. The detailed Name values of filter criteria are as follows:
  • page-id: Filter by page ID;
  • name: Filter by page name;
  • description: Filter by page description;
  • content-type: Filter by page type.
    		•
    Offset No Integer The offset of paginated query. Default value: 0.
    Limit No Integer The limit of paginated query. Default value: 20. Maximum value: 1,000.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of custom error pages.
    ErrorPages Array of CustomErrorPage Custom error page data list.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the custom response page list

    This example shows you how to query the custom response page list.

    Input Example

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

{
    "ZoneId": "zone-2kplomhisdcb",
    "Filters": [
        {
            "Name": "name",
            "Values": [
                "web protection response page"
            ]
        }
    ],
    "Offset": 1,
    "Limit": 20
}

    Output Example

    {
    "Response": {
        "ErrorPages": [
            {
                "PageId": "p-2kplomhisdcb",
                "Name": "Web Protection Response Page",
                "ContentType": "application/json",
                "Content": "{\"title\": \"custom response page title\",\"content\": \"custom response page content\"}",
                "Description": "custom web protection response page"
            }
        ],
        "TotalCount": 1,
        "RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"
    }
}

    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
    InternalError.RouteError The backend routing address is incorrect.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy