文档中心>API 中心>全球应用加速>规则相关接口>定制域名指定错误码的错误响应

定制域名指定错误码的错误响应

最近更新时间:2024-03-12 01:31:51

我的收藏

1. 接口描述

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

定制域名指定错误码的错误响应

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDomainErrorPageInfo。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,此参数为可选参数。
ListenerId String 监听器ID
示例值:0
Domain String 域名
示例值:a.com
ErrorNos.N Array of Integer 原始错误码
示例值:["501\n","502\n"]
Body String 新的响应包体
示例值:helloword
NewErrorNo Integer 新错误码
示例值:400
ClearHeaders.N Array of String 需要删除的响应头
示例值:[]
SetHeaders.N Array of HttpHeaderParam 需要设置的响应头

3. 输出参数

参数名称 类型 描述
ErrorPageId String 错误定制响应的配置ID
示例值:errorPage-1fewf
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateDomainErrorPageInfo

输入示例

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

{
    "Body": "helloword",
    "Domain": "a.com",
    "ListenerId": "0",
    "ErrorNos": [
        "502",
        "501"
    ],
    "NewErrorNo": "400"
}

输出示例

{
    "Response": {
        "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8",
        "ErrorPageId": "errorPage-1fewf"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.DomainAlreadyExisted 该域名在监听器下已使用。
FailedOperation.InvalidListenerProtocol 无效的监听器协议。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.ProxyStatusNotInRuning 通道处于非运行状态,不能添加监听器。
FailedOperation.ProxyVersionNotSupport 不支持该版本通道。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。