1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。
本接口为异步接口,本接口返回成功后需以返回的RequestID为入参,调用DescribeTaskStatus接口查询本次任务是否成功。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteRule。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例ID。 示例值:lb-cuxw2rm0 |
ListenerId | 是 | String | 负载均衡监听器ID。 示例值:lbl-4fbxq45k |
LocationIds.N | 否 | Array of String | 要删除的转发规则的ID组成的数组。 示例值:["loc-5lc6****"] |
Domain | 否 | String | 要删除的转发规则的域名,如果是多域名,可以指定多域名列表中的任意一个。 示例值:foo.net |
Url | 否 | String | 要删除的转发规则的转发路径。 示例值:/bar2 |
NewDefaultServerDomain | 否 | String | 监听器下必须配置一个默认域名,当需要删除默认域名时,可以指定另一个域名作为新的默认域名,如果新的默认域名是多域名,可以指定多域名列表中的任意一个。 示例值:www.default.example.com |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除一条转发规则
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteRule
<公共请求参数>
{
"Url": "/bar2",
"Domain": "foo.net",
"ListenerId": "lbl-4fbxq45k",
"LoadBalancerId": "lb-cuxw2rm0"
}
输出示例
{
"Response": {
"RequestId": "ba2d4eb1-c7c5-480c-98e4-9b7b6a0fd498"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ResourceInOperating | 正在操作指定的资源,请稍后重试。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Length | 参数长度错误。 |
UnauthorizedOperation | 未授权操作。 |