1. 接口描述
接口请求域名: clb.api3.gsesgpucloud.com。
修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
默认接口请求频率限制:20次/秒。
接口更新时间:2020-09-04 14:41:39。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:ModifyLoadBalancerAttributes |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
LoadBalancerId | 是 | 否 | String | 负载均衡的唯一ID 示例值: lb-6efswuxa |
LoadBalancerName | 否 | 否 | String | 负载均衡实例名称 示例值: newlbname |
TargetRegionInfo | 否 | 否 | TargetRegionInfo | 负载均衡绑定的后端服务的地域信息 示例值:查看 |
InternetChargeInfo | 否 | 否 | InternetAccessible | 网络计费相关参数 示例值:查看 |
LoadBalancerPassToTarget | 否 | 否 | Bool | Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。 示例值: true |
ChargeType | 否 | 否 | String | 负载均衡实例的计费类型,后付费:POSTPAID_BY_HOUR,预付费:PREPAID。 示例值: POSTPAID_BY_HOUR |
SwitchFlag | 否 | 否 | Uint64 | 不同计费模式之间的切换:0表示不切换,1表示预付费和后付费切换,2表示后付费之间切换。默认值:0 示例值: 0 |
PrepaidInfo | 否 | 否 | LBChargePrepaid | 负载均衡实例的预付费相关属性 示例值:查看 |
ExclusiveCluster | 否 | 否 | ExclusiveCluster | 7层集群列表 示例值:查看 |
SnatPro | 否 | 否 | Bool | 是否开启跨地域绑定2.0功能(TCE不支持) 示例值: false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealName | String | 切换负载均衡计费方式时,可用此参数查询切换任务是否成功。 示例值: null |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
LimitExceeded | 超过配额限制 |
MissingParameter | 缺少参数错误。 |
FailedOperation | 操作失败 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameter.LBIdNotFound | 负载均衡实例ID错误。 |
InvalidParameterValue.Duplicate | 参数值有重复。 |
ResourceInsufficient | 资源不足 |
UnauthorizedOperation | 未授权操作 |
InternalError | 内部错误 |
InvalidParameterValue | 参数取值错误 |
InvalidParameterValue.Length | 参数长度错误。 |
InvalidParameter.RegionNotFound | 地域无效。 |