1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
本接口(DestroyProxies)用于销毁。通道销毁后,不再产生任何费用。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DestroyProxies。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Force | 是 | Integer | 强制删除标识。 1,强制删除该通道列表,无论是否已经绑定了源站; 0,如果已绑定了源站,则无法删除。 删除多通道时,如果该标识为0,只有所有的通道都没有绑定源站,才允许删除。 示例值:1 |
InstanceIds.N | 否 | Array of String | (旧参数,请切换到ProxyIds)通道实例ID列表。 示例值:["link-34524rerf"] |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 更多详细信息请参阅:如何保证幂等性。 示例值:aeew3eq34r324f |
ProxyIds.N | 否 | Array of String | (新参数)通道实例ID列表。 示例值:["link-11112222\r\n","link-11113333\r\n"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InvalidStatusInstanceSet | Array of String | 处于不可销毁状态下的通道实例ID列表。 示例值:["link-11112222"] |
OperationFailedInstanceSet | 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: DestroyProxies
<公共请求参数>
{
"Force": 1,
"ProxyIds": [
"link-33ffq3wz",
"link-3752gn4p"
]
}
输出示例
{
"Response": {
"OperationFailedInstanceSet": [],
"RequestId": "d4228b1a-8b3b-43d6-a8e7-272d158ff332",
"InvalidStatusInstanceSet": [
"link-3752gn4p"
]
}
}
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.AccountBalanceInsufficient | 账户余额不足,无法创建该通道。 |
FailedOperation.ActionIsDoing | 操作正在执行中,请勿重复操作。 |
FailedOperation.BelongDifferentGroup | 该批通道归属于不同的通道组,无法批量操作。 |
FailedOperation.DuplicatedRequest | 重复的请求,请检查ClientToken的值。 |
FailedOperation.NonStandardProxy | 该通道为非标通道,限制所有写操作。 |
FailedOperation.RealServerAlreadyBound | 已经绑定了源站,无法删除。 |
FailedOperation.UnTagResourcesFailed | 标签资源解绑失败。 |
FailedOperation.UserNotConfirmProtocol | 未开通协议。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.AccountViolation | 账号下存在违规资源,详情请查看站内信或邮件。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |