Skip to Content
负载均衡 ULB ALBupdate_load_balancer_attribute_json

更新应用型负载均衡实例属性 - UpdateLoadBalancerAttribute

简介

更新一个应用型负载均衡实例的属性

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 UpdateLoadBalancerAttributeYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口Yes
LoadBalancerIdstring应用型负载均衡实例的IDYes
Namestring名字,不传该参数则默认不修改No
Tagstring负载均衡实例所属的业务组ID,不传该参数则默认不修改; 传空则为Default业务组No
Remarkstring负载均衡实例的备注信息,不传该参数则默认不修改,限定字符长度:[0-255]No
AccessLogConfigAccessLogConfig(应用型专用)访问日志相关配置,不传则默认不修改。具体结构详见 AccessLogConfigNo

数据模型

AccessLogConfig

字段名类型描述信息必填
Enabledbool应用型专用)是否开启访问日志记录功能; 默认值:false; 不传该参数则默认不修改No
US3BucketNamestring(应用型专用)用于存储访问日志的bucket; 开启日志功能时必传; 修改日志时不传该参数或传空则默认不修改No
US3TokenIdstring(应用型专用)上传访问日志到bucket所需的token; 开启日志功能时必传; 修改日志时不传该参数或传空则默认不修改No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No

示例

请求示例

curl 'https://api.tnqacloud.com' \ --header 'Content-Type: application/json' \ --data '{ "Action": "UpdateLoadBalancerAttribute", "Region": "cn-bj2", "ProjectId": "org-XXXXX", "LoadBalancerId": "alb-XXXXX", "Name": "albName", "Tag": "albTag", "Remark": "albRemark", "AccessLogConfig": { "Enabled": true, "US3BucketName": "alb_log", "US3TokenId": "xxx-xxx-xxx-xxx-xxx" } }'

响应示例

{ "Action": "UpdateLoadBalancerAttributeResponse", "RetCode": 0 }