边缘安全加速平台 EO 查询自定义响应页面列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

查询自定义错误页列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCustomErrorPages。
Version	是	String	公共参数，本接口取值：2022-09-01。
Region	否	String	公共参数，此参数为可选参数。
ZoneId	是	String	站点 ID。
Filters.N	否	Array of AdvancedFilter	过滤条件，Filters.Values 的上限为20，详细的过滤条件Name值如下： page-id：按照页面 ID 进行过滤； name：按照页面名称进行过滤； description：按照页面描述过滤； content-type：按照页面类型过滤。
Offset	否	Integer	分页查询偏移量。默认值：0。
Limit	否	Integer	分页查询限制数目。默认值：20，最大值：1000。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	自定义错误页面总数。
ErrorPages	Array of CustomErrorPage	自定义错误页面数据列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 自定义错误页面查询列表

自定义错误页面查询列表

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomErrorPages
<公共请求参数>

{
    "ZoneId": "zone-2kplomhisdcb",
    "Filters": [
        {
            "Name": "name",
            "Values": [
                "web防护错误页面"
            ]
        }
    ],
    "Offset": 1,
    "Limit": 20
}

输出示例

{
    "Response": {
        "ErrorPages": [
            {
                "PageId": "p-2kplomhisdcb",
                "Name": "web防护错误页面",
                "ContentType": "application/json",
                "Content": "{\"title\": \"自定义错误页面title\",\"content\": \"自定义错误页面内容\"}",
                "Description": "自定义的web防护错误页面"
            }
        ],
        "TotalCount": 1,
        "RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError.RouteError	后端服务路由地址错误。