接口描述
ModifyLoadBalancerAttributes 接口可以根据您的输入参数来修改负载均衡实例的基本配置信息。
接口访问域名:lb.api.qcloud.com
请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为 ModifyLoadBalancerAttributes。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
loadBalancerId | 是 | String | 负载均衡实例唯一 ID,可通过 DescribeLoadBalancers 接口查询。 |
loadBalancerName | 否 | String | 负载均衡实例名称,规则:1-50 个英文、汉字、数字、连接线“-”或下划线“_”。 |
domainPrefix | 否 | String | 域名前缀,负载均衡实例的域名由用户输入的域名前缀与配置文件中的域名后缀一起组合而成,保证是唯一的域名。 规则:1-20 个小写英文字母、数字或连接线“-”。 内网类型的负载均衡实例不能配置该字段。 |
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0 表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误码,成功返回 Success,失败有相应的英文说明。 |
requestId | Int | 请求任务 ID,该接口为异步任务,可根据本参数调用 DescribeLoadBalancersTaskResult 接口来查询任务操作结果。 |
示例
请求
https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerAttributes &<公共请求参数> &loadBalancerId=lb-abcdefgh &loadBalancerName=my-lb-name
返回
{
"code" : 0,
"message" : "",
"codeDesc": "Success",
"requestId" : 1234
}