API 文档

根据域名删除转发规则

最近更新时间:2020-09-02 08:09:52

1. 接口描述

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

本接口(DeleteDomain)仅适用于7层监听器,用于删除该监听器下对应域名及域名下的所有规则,所有已绑定源站的规则将自动解绑。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteDomain。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,本接口不需要传递此参数。
ListenerId String 监听器ID
Domain String 需要删除的域名
Force Integer 是否强制删除已绑定源站的转发规则,0非强制,1强制。
当采用非强制删除时,如果域名下已有规则绑定了源站,则无法删除。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据域名删除转发规则

输入示例

https://gaap.tencentcloudapi.com/?Action=DeleteDomain
&ListenerId=0
&Domain=a.a.com
&Force=1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态,无法操作。
FailedOperation.ListenerHasTask 监听器正在操作中,请勿重复操作。
FailedOperation.ProxyStatusNotInRuning 通道处于非运行状态,不能添加监听器。
FailedOperation.RealServerAlreadyBound 已经绑定了源站,无法删除。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
目录