1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
该接口(DeleteListeners)用于批量删除通道或通道组的监听器,包括4/7层监听器。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteListeners。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ListenerIds.N | 是 | Array of String | 待删除的监听器ID列表 示例值:["listener-o0f3at99\n"] |
Force | 是 | Integer | 已绑定源站的监听器是否允许强制删除,1:允许, 0:不允许 示例值:1 |
GroupId | 否 | String | 通道组ID,该参数和ProxyId必须设置一个,但不能同时设置。 示例值:lg-04tnkmt9 |
ProxyId | 否 | String | 通道ID,该参数和GroupId必须设置一个,但不能同时设置。 示例值:link-3d85gh |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
OperationFailedListenerSet | Array of String | 删除操作失败的监听器ID列表 示例值:[] |
OperationSucceedListenerSet | Array of String | 删除操作成功的监听器ID列表 示例值:["listener-o0f3at99"] |
InvalidStatusListenerSet | Array of String | 无效的监听器ID列表,如:监听器不存在,监听器对应实例不匹配 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除监听器
删除监听器
输入示例
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteListeners
<公共请求参数>
{
"ProxyId": "link-3d85gh",
"Force": 1,
"ListenerIds": [
"listener-o0f3at99"
]
}
输出示例
{
"Response": {
"OperationFailedListenerSet": [],
"OperationSucceedListenerSet": [
"listener-o0f3at99"
],
"InvalidStatusListenerSet": [],
"RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.NotEnterpriseAuthorization | 非企业认证客户。 |
AuthFailure.UnauthorizedOperation | 子账户未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.GroupStatusNotInRuning | 通道组状态为非运行状态,无法操作。 |
FailedOperation.InstanceStatusNotInRuning | 通道状态为非运行状态,无法操作。 |
FailedOperation.ListenerHasTask | 监听器正在操作中,请勿重复操作。 |
FailedOperation.NonStandardProxy | 该通道为非标通道,限制所有写操作。 |
FailedOperation.RealServerAlreadyBound | 已经绑定了源站,无法删除。 |
FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.AccountViolation | 账号下存在违规资源,详情请查看站内信或邮件。 |
UnauthorizedOperation | 未授权操作。 |