API 文档

删除通道组

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

1. 接口描述

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

本接口(DeleteProxyGroup)用于删除通道组。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteProxyGroup。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,本接口不需要传递此参数。
GroupId String 需要删除的通道组ID。
Force Integer 强制删除标识。其中:
0,不强制删除,
1,强制删除。
默认为0,当通道组中存在通道或通道组中存在监听器/规则绑定了源站时,且Force为0时,该操作会返回失败。

3. 输出参数

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

4. 示例

示例1 删除通道组

输入示例

https://gaap.tencentcloudapi.com/?Action=DeleteProxyGroup
&GroupId=lg-b7h4d02f
&Force=0
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "19a021f8-dff3-4890-8e7a-ed5054e22e49"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.DeleteProxyGroupProxyRemained 通道组中存在通道,无法删除。
FailedOperation.RealServerAlreadyBound 已经绑定了源站,无法删除。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
目录