删除通道监听器

最近更新时间:2019-08-09 19:18:44

1. 接口描述

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

该接口(DeleteListeners)用于批量删除通道或通道组的监听器,包括4/7层监听器。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteListeners
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
ListenerIds.N Array of String 待删除的监听器ID列表
Force Integer 已绑定源站的监听器是否允许强制删除,1:允许, 0:不允许
GroupId String 通道组ID,该参数和GroupId必须设置一个,但不能同时设置。
ProxyId String 通道ID,该参数和GroupId必须设置一个,但不能同时设置。

3. 输出参数

参数名称 类型 描述
OperationFailedListenerSet Array of String 删除操作失败的监听器ID列表
OperationSucceedListenerSet Array of String 删除操作成功的监听器ID列表
InvalidStatusListenerSet Array of String 无效的监听器ID列表,如:监听器不存在,监听器对应实例不匹配
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除监听器

删除监听器

输入示例

https://gaap.tencentcloudapi.com/?Action=DeleteListeners
&ProxyId=link-3d85gh
&ListenerIds.0=listener-o0f3at99
&Force=1
&<公共请求参数>

输出示例

{
  "Response": {
    "OperationFailedListenerSet": [],
    "OperationSucceedListenerSet": [
      "listener-o0f3at99"
    ],
    "InvalidStatusListenerSet": [],
    "RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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