Skip to Content
负载均衡 ULB ALB创建CLB的VServer - CreateVServer

创建CLB的VServer - CreateVServer

简介

创建CLB的VServer实例，定义监听的协议和端口以及负载均衡算法

定义

公共参数

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

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
ULBIdstring传统型负载均衡实例IDYes
VServerNamestringVServer实例名称，默认为”VServer”No
ListenTypestring监听器类型，枚举值，RequestProxy ，请求代理；PacketsTransmit ，报文转发。默认为RequestProxyNo
ProtocolstringVServer实例的协议，请求代理模式下有 HTTP、HTTPS、TCP，报文转发下有 TCP，UDP。默认为“HTTP”No
FrontendPortintVServer后端端口，取值范围[1-65535]；默认值为80No
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：此字段传入自定义会话保持StringNo
ClientTimeoutintListenType为RequestProxy时表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；ListenType为PacketsTransmit时表示连接保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持No
MonitorTypestring健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测；Customize -> UDP检查
请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path;
报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize，默认值为Ping		No
Domainstring根据MonitorType确认； 当MonitorType为Path时，此字段有意义，代表HTTP检查域名No
Pathstring根据MonitorType确认； 当MonitorType为Path时，此字段有意义，代表HTTP检查路径No
RequestMsgstring根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文No
ResponseMsgstring根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文No
SecurityPolicyIdstring安全策略组ID，默认值’Default’No
EnableCompressionint0:关闭 1:开启，用于数据压缩功能No
ForwardPortint重定向端口，取值范围[0-65535]；默认值为0，代表关闭；仅HTTP协议支持开启重定向功能No
EnableHTTP2int0:关闭 1:开启，用于开启http2功能；默认值为0No

响应字段

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

示例

请求示例

https://api.an-link.com/?Action=CreateVServer
&Region=cn-bj2
&ProjectId=project-XXXXX
&Action=CreateVServer
&ULBId=ulb-XXXXX
&ListenType=RequestProxy
&PersistenceType=None
&PersistenceInfo=hsdhs
&Protocol=TCP
&VServerName=testvserver1
&Method=Source
&FrontendPort=80
&ClientTimeout=180
&MonitorType=EAWmpFKo
&Domain=HbTPGDtS
&Path=ScoEPSuy
&EnableHTTP2=1
&RequestMsg=zMpxnICB
&ResponseMsg=gKFbkkOl
&SecurityPolicyId=OEKOGXjU
&EnableCompression=1
&ForwardPort=6

响应示例

{
  "Action": "CreateVServerResponse",
  "RetCode": 0,
  "VServerId": "vserver-XXXX"
}
创建传统型负载均衡负载均衡 - CreateULB传统型负载均衡绑定SSL证书 - BindSSL