修改自定义响应页面

最近更新时间:2024-06-07 12:09:20

我的收藏

1. 接口描述

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

修改自定义错误页面。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyCustomErrorPage。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
PageId String 自定义错误页面 ID。
ZoneId String 站点 ID。
Name String 自定义错误页名称,名称为2 - 60个字符。
Description String 自定义错误页描述,描述内容不超过60个字符。
ContentType String 自定义错误页面类型,取值有:
  • text/html。
  • application/json。
  • plain/text。
  • text/xml。
  • Content String 自定义错误页面内容。内容不超过 2KB。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改自定义错误页面

    修改自定义错误页面。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyCustomErrorPage
    <公共请求参数>
    
    {
        "PageId": "p-2kplomhisdcb",
        "ZoneId": "zone-2kplomhisdcb",
        "Name": "web防护自定义错误页面",
        "Description": "web防护自定义错误页面",
        "ContentType": "application/json",
        "Content": "{\"title\": \"自定义错误页面title\",\"content\": \"自定义错误页面内容\"}"
    }

    输出示例

    {
        "Response": {
            "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。

    命令行工具

    6. 错误码

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

    错误码 描述
    ResourceNotFound 资源不存在。