创建后端服务器组
功能介绍
创建后端服务器组。
接口约束
-
指定session-persistence参数时,只有当type是APP_COOKIE时,才可以设置cookie_name。
-
若指定listener_id参数,则对应的监听器必须未绑定后端服务器组。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/elb/pools
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pool |
是 |
CreatePoolOption object |
参数解释:创建pool的请求体。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
admin_state_up |
否 |
Boolean |
参数解释:后端服务器组的管理状态,只支持设置为true。 |
description |
否 |
String |
参数解释:后端服务器组的描述信息。 |
lb_algorithm |
是 |
String |
参数解释:后端服务器组的负载均衡算法。 约束限制:
取值范围:
|
listener_id |
否 |
String |
参数解释:后端服务器组关联的监听器的ID。 约束限制:
|
loadbalancer_id |
否 |
String |
参数解释:后端服务器组关联的负载均衡器ID。 约束限制:
|
name |
否 |
String |
参数解释:后端服务器组的名称。 |
project_id |
否 |
String |
参数解释:后端服务器组所属的项目ID。 |
protocol |
是 |
String |
参数解释:后端服务器组的后端协议。 约束限制:
取值范围:TCP、UDP、TLS、GRPC、HTTP、HTTPS和QUIC。 |
session_persistence |
否 |
参数解释:会话持久性对象。 |
|
slow_start |
否 |
CreatePoolSlowStartOption object |
参数解释:慢启动信息。开启慢启动后,将会在设定的时间段(duration)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。 约束限制:当后端服务器组的协议为HTTP/HTTPS时有效,其他协议传入该字段将报错。 |
member_deletion_protection_enable |
否 |
Boolean |
参数解释:是否开启删除保护。 取值范围:false不开启,true开启,默认false。 退场时需要先关闭所有资源的删除保护开关。 |
vpc_id |
否 |
String |
参数解释:后端服务器组关联的虚拟私有云的ID。 约束限制:
|
type |
否 |
String |
参数解释:后端服务器组的类型。 约束限制:
取值范围:
|
ip_version |
否 |
String |
参数解释:后端服务器组支持的IP版本。 取值范围:
|
quic_cid_hash_strategy |
否 |
QuicCidHashStrategy object |
参数解释:后端服务器组基于部分DST CID的多径分发策略配置。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cookie_name |
否 |
String |
参数解释:cookie名称。 约束限制:
取值范围:
|
type |
是 |
String |
参数解释:会话保持类型。 约束限制:
取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 |
persistence_timeout |
否 |
Integer |
参数解释:会话保持的时间。当type为APP_COOKIE时不生效。 取值范围:
|
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
参数解释:请求ID。 注:自动生成 。 |
pool |
Pool object |
参数解释:后端服务器组对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
admin_state_up |
Boolean |
参数解释:后端服务器组的管理状态。 |
description |
String |
参数解释:后端服务器组的描述信息。 |
healthmonitor_id |
String |
参数解释:后端服务器组关联的健康检查的ID。 |
id |
String |
参数解释:后端服务器组的ID。 |
lb_algorithm |
String |
参数解释:后端服务器组的负载均衡算法。 约束限制:
取值范围:
|
listeners |
Array of ListenerRef objects |
参数解释:后端服务器组关联的监听器ID列表。 |
loadbalancers |
Array of LoadBalancerRef objects |
参数解释:后端服务器组关联的负载均衡器ID列表。 |
members |
Array of MemberRef objects |
参数解释:后端服务器组中的后端服务器ID列表。 |
name |
String |
参数解释:后端服务器组的名称。 |
project_id |
String |
参数解释:后端服务器组所在的项目ID。 |
protocol |
String |
参数解释:后端服务器组的后端协议。 约束限制:
取值范围:TCP、UDP、TLS、GRPC、HTTP、HTTPS和QUIC。 |
session_persistence |
SessionPersistence object |
参数解释:会话持久性对象。 |
ip_version |
String |
参数解释:后端服务器组支持的IP版本。 取值范围:
|
slow_start |
SlowStart object |
参数解释:慢启动信息。开启慢启动后,将会在设定的时间段(duration)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。 约束限制:当后端服务器组的协议为HTTP/HTTPS时有效,其他协议传入该字段将报错。 |
member_deletion_protection_enable |
Boolean |
参数解释:是否开启误删保护。 取值范围:false不开启,true开启。 退场时需要先关闭所有资源的删除保护开关。 |
created_at |
String |
参数解释:创建时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
updated_at |
String |
参数解释:更新时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
vpc_id |
String |
参数解释:后端服务器组关联的虚拟私有云的ID。 |
type |
String |
参数解释:后端服务器组的类型。 取值范围:
|
enterprise_project_id |
String |
参数解释:IP地址组所在的企业项目ID。 |
quic_cid_hash_strategy |
QuicCidHashStrategy object |
参数解释:后端服务器组基于部分DST CID的多径分发策略。 |
参数 |
参数类型 |
描述 |
---|---|---|
cookie_name |
String |
参数解释:cookie名称。 约束限制:
取值范围:
|
type |
String |
参数解释:会话保持类型。 约束限制:
取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 |
persistence_timeout |
Integer |
参数解释:会话保持的时间。当type为APP_COOKIE时不生效。 取值范围:
|
请求示例
-
创建一个后端服务器组,并指定协议为TCP协议
POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools { "pool" : { "name" : "My pool", "lb_algorithm" : "LEAST_CONNECTIONS", "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193", "protocol" : "TCP", "member_deletion_protection_enable" : false } }
-
创建一个后端服务器组,并指定协议为HTTP协议
POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools { "pool" : { "name" : "My pool", "lb_algorithm" : "LEAST_CONNECTIONS", "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193", "protocol" : "HTTP", "slow_start" : { "enable" : true, "duration" : 50 }, "member_deletion_protection_enable" : false } }
响应示例
状态码:201
POST操作正常返回。
{ "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor_id" : null, "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" } ], "members" : [ ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool", "ip_version" : "v4", "slow_start" : null }, "request_id" : "2d974978-0733-404d-a21a-b29204f4803a" }
状态码
状态码 |
描述 |
---|---|
201 |
POST操作正常返回。 |
错误码
请参见错误码。