Skip to Content
负载均衡 ULB ALB更新传统型负载均衡VServer属性 - UpdateVServerAttribute

更新传统型负载均衡VServer属性 - UpdateVServerAttribute

简介

更新传统型负载均衡VServer实例属性

ℹ️ VServerId 对应 CreateVServer 返回的 VServerId
或者 DescribeVServer / DescribeULB 返回的 ULBVServerSet 中的 VServerId

没有传的参数都不会做修改

定义

公共参数

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

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口Yes
ULBIdstring传统型负载均衡实例IDYes
VServerIdstring传统型负载均衡VServer实例IDYes
VServerNamestringVServer实例名称，若无此字段则不做修改No
MethodstringVServer负载均衡模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）; WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数；Backup -> 主备模式。
ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin,Backup在请求代理和报文转发中使用。
默认为：“Roundrobin”		No
PersistenceTypestringVServer会话保持模式，若无此字段则不做修改。枚举值：None：关闭；ServerInsert：自动生成KEY；UserDefined：用户自定义KEY。No
PersistenceInfostring根据PersistenceType确定: None或ServerInsert, 此字段无意义; UserDefined, 则此字段传入用户自定义会话保持String. 若无此字段则不做修改No
ClientTimeoutint请求代理的VServer下表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；报文转发的VServer下表示回话保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持No
MonitorTypestring健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测，Customize -> UDP检查

请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path;
报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize，默认值为Ping		No
DomainstringMonitorType 为 Path 时指定健康检查发送请求时HTTP HEADER 里的域名No
PathstringMonitorType 为 Path 时指定健康检查发送请求时的路径，默认为 /No
RequestMsgstring根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文No
ResponseMsgstring根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文No
SecurityPolicyIdstring安全策略组IDNo
EnableCompressionint0:关闭 1:开启，用于数据压缩功能No
ForwardPortint重定向端口，取值范围[0-65535]；默认值为0，代表关闭；仅HTTP协议支持开启重定向功能No
EnableHTTP2int0:关闭 1:开启，用于开启http2功能；默认值为0No

响应字段

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

示例

请求示例

https://api.an-link.com/?Action=UpdateVServerAttribute
&Region=cn-bj2
&ProjectId=project-XXXXX
&ULBId=ulb-XXXX
&VServerId=vserver-XXXX
&VServerName=Testapi
&Protocol=HTTP 
&Method=Roundrobin
&PersistenceType=None
&PersistenceInfo=None
&ClientTimeout=60
&MonitorType=Port
&RequestMsg=QHpxxRrA
&ResponseMsg=rVBUBWIh
&SecurityPolicyId=cbupUwHT
&EnableCompression=1
&ForwardPort=4
&EnableHTTP2=1

响应示例

{
  "Action": "UpdateVServerAttributeResponse",
  "RetCode": 0
}
更新传统型负载均衡属性 - UpdateULBAttribute更新传统型负载均衡的后端实例属性 - UpdateBackendAttribute