点击领取2000元阿里云代金券,付款抵现金用,云服务器69元/年限时抢>>> 点击咨询成为阿里云VIP客户享永久折扣>>>
点击领取2860元腾讯云代金券,付款抵现金用,云服务器88元/年限时抢>>> 点击成为腾讯云VIP客户享永久折扣优惠>>> 点击进入华为云最新优惠活动现场>>> 点击成为华为云VIP客户享永久折扣优惠>>>
1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 |
必选 |
类型 |
描述 |
Action |
是 |
String |
公共参数,本接口取值:ModifyLoadBalancerAttributes。 |
Version |
是 |
String |
公共参数,本接口取值:2018-03-17。 |
Region |
是 |
String |
公共参数,详见产品支持的 地域列表。 |
LoadBalancerId |
是 |
String |
负载均衡的唯一ID |
LoadBalancerName |
否 |
String |
负载均衡实例名称 |
TargetRegionInfo |
否 |
TargetRegionInfo |
负载均衡绑定的后端服务的地域信息 |
InternetChargeInfo |
否 |
InternetAccessible |
网络计费相关参数 |
LoadBalancerPassToTarget |
否 |
Boolean |
Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。 |
SnatPro |
否 |
Boolean |
是否开启SnatPro |
3. 输出参数
参数名称 |
类型 |
描述 |
DealName |
String |
切换负载均衡计费方式时,可用此参数查询切换任务是否成功。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId |
String |
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改负载均衡实例名称
输入示例
https://clb.tencentcloudapi.com/?Action=ModifyLoadBalancerAttributes
&LoadBalancerId=lb-6efswuxa
&LoadBalancerName=newlbname
&<公共请求参数>
输出示例
{
"Response": {
"DealName": null,
"RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
}
}
示例2 设置负载均衡实例的跨域属性
输入示例
https://clb.tencentcloudapi.com/?Action=ModifyLoadBalancerAttributes
&LoadBalancerId=lb-6efswuxa
&TargetRegionInfo.Region=ap-shanghai
&TargetRegionInfo.VpcId=vpc-abcd1234
&<公共请求参数>
输出示例
{
"Response": {
"DealName": null,
"RequestId": "78a40898-8210-44c7-8bc6-f83e5087ad54"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 |
描述 |
FailedOperation |
操作失败。 |
InternalError |
内部错误。 |
InvalidParameter |
参数错误。 |
InvalidParameter.FormatError |
参数格式错误。 |
InvalidParameter.LBIdNotFound |
负载均衡实例ID错误。 |
InvalidParameter.RegionNotFound |
地域无效。 |
InvalidParameterValue |
参数取值错误。 |
InvalidParameterValue.Duplicate |
参数值有重复。 |
InvalidParameterValue.Length |
参数长度错误。 |
LimitExceeded |
超过配额限制。 |
MissingParameter |
缺少参数错误。 |
ResourceInsufficient |
资源不足。 |
UnauthorizedOperation |
未授权操作。 |
|