文档中心 负载均衡 API 文档 负载均衡相关接口 修改负载均衡实例的属性

修改负载均衡实例的属性

最近更新时间:2019-09-20 18:16:13

1. 接口描述

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

修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyLoadBalancerAttributes
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡的唯一ID
LoadBalancerName String 负载均衡实例名称
TargetRegionInfo TargetRegionInfo 负载均衡绑定的后端服务的地域信息
InternetChargeInfo InternetAccessible 网络计费相关参数,注意,目前只支持修改最大出带宽,不支持修改网络计费方式。

3. 输出参数

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

4. 示例

示例1 修改负载均衡实例名称

输入示例

https://clb.tencentcloudapi.com/?Action=ModifyLoadBalancerAttributes
&LoadBalancerId=lb-6efswuxa
&LoadBalancerName=newlbname
&<公共请求参数>

输出示例

{
  "Response": {
    "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": {
    "RequestId": "78a40898-8210-44c7-8bc6-f83e5087ad54"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameter.RegionNotFound 地域无效。
InvalidParameterValue 参数取值错误
InvalidParameterValue.Duplicate 参数值有重复。
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制
MissingParameter 缺少参数错误。
ResourceInsufficient 资源不足
UnauthorizedOperation 未授权操作