创建后端服务器

pool_id

是

String

参数解释：后端服务器组ID。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

project_id

是

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

X-Auth-Token

是

String

参数解释：IAM鉴权Token。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

member

是

CreateMemberOption object

参数解释：后端服务器对象。

约束限制：不涉及

address

是

String

参数解释：后端服务器对应的IP地址。

约束限制：

• 若subnet_cidr_id为空，表示添加IP类型后端，此时address必须为私网IPv4地址。

• 若subnet_cidr_id不为空，表示是一个关联到ECS的后端服务器。该IP地址必须在subnet_cidr_id对应的子网网段中，可以是私网IPv4或IPv6。

取值范围：不涉及

默认取值：不涉及

admin_state_up

否

Boolean

参数解释：后端服务器的管理状态。

约束限制：虽然创建、更新请求支持该字段，但实际取值决定于后端服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。

取值范围：true 弹性云服务器存在，false 弹性云服务器不存在。

默认取值：不涉及

name

否

String

参数解释：后端服务器名称。注意：该名称并非ECS名称，若不传则返回为空。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

project_id

否

String

参数解释：后端服务器所在的项目ID。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

protocol_port

否

Integer

参数解释：后端服务器业务端口。

约束限制：

• 在开启端口透传的pool下创建member传该字段不生效，可不传该字段。

• 网关型LB，即pool协议为IP时，protocol_port必须设置为0。

取值范围：不涉及

默认取值：不涉及

subnet_cidr_id

否

String

参数解释：后端服务器所在的子网，可以是IPv4或IPv6子网。若是IPv4子网，使用对应子网的子网ID（neutron_subnet_id）；若是IPv6子网，使用对应子网的网络ID（neutron_network_id）。

IPv4子网的子网ID可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets响应参数中的neutron_subnet_id得到

IPv6子网的网络ID可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到

约束限制：

• 该子网和关联的负载均衡器的子网必须在同一VPC下。

• 若所属LB的IP类型后端转发已开启（ip_target_enable=true），则该字段可以不传，表示添加跨VPC的后端服务器。此时address必须为私网IPv4地址，所在的pool的协议必须为UDP/TCP/TLS/HTTP/HTTPS/QUIC/GRPC。

• 若所属LB未开启IP类型后端转发，该参数必填。

• 网关型LB，即pool协议为IP时，必须指定该子网，且必须和负载均衡器的子网在同一个VPC下，但不能相同。

取值范围：不涉及

默认取值：不涉及

weight

否

Integer

参数解释：后端服务器的权重，请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。

权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。

约束限制：若所在pool的lb_algorithm取值为SOURCE_IP或QUIC_CID，该字段无效。

取值范围：0-100，默认1。

默认取值：不涉及

availability_zone

否

String

参数解释：后端服务器的可用区。

约束限制：

• 仅支持IP类型后端服务器设置该字段。且后端服务器组开启可用区亲和时，IP类型后端服务器必须配置该字段为有效非空值。

取值范围：本region中ECS可选择的可用区。

默认取值：不涉及

request_id

String

参数解释：请求ID。

取值范围：由数字、小写字母和中划线（-）组成的字符串，自动生成。

member

Member object

参数解释：后端服务器对象。

id

String

参数解释：后端服务器ID。

取值范围：不涉及

availability_zone

String

参数解释：后端服务器所在的可用区。

取值范围：不涉及

name

String

参数解释：后端服务器名称。

取值范围：不涉及

注意：该名称并非ECS名称。

project_id

String

参数解释：后端服务器所在的项目ID。

取值范围：不涉及

admin_state_up

Boolean

参数解释：后端服务器的管理状态。

取值范围：true、false。

subnet_cidr_id

String

参数解释：后端服务器所在的子网，可以是IPv4或IPv6子网。若是IPv4子网，使用对应子网的子网ID（neutron_subnet_id）；若是IPv6子网，使用对应子网的网络ID（neutron_network_id）。

ipv4子网的子网ID可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到

ipv6子网的网络ID可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到

取值范围：不涉及

protocol_port

Integer

参数解释：后端服务器业务端口。

取值范围：不涉及

weight

Integer

参数解释：后端服务器的权重，请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。

权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。

取值范围：0-100

address

String

参数解释：后端服务器对应的IP地址。

取值范围：不涉及

ip_version

String

参数解释：当前后端服务器的IP地址版本，由后端系统自动根据传入的address字段确定。

取值范围：v4、v6

operating_status

String

参数解释：后端服务器的健康状态。当status非空时，以status字段中监听器粒度的健康检查状态优先。

取值范围：

• NO_MONITOR：后端服务器所在的服务器组没有开启健康检查。

• INITIAL：初始化中，表示负载均衡实例配置了健康检查，但查不到数据。

• ONLINE：后端服务器正常。

• OFFLINE：后端服务器关联的ECS服务器不存在或已关机。

• UNKNOWN：未关联LB实例的pool下的member，或者创建后从未关联ECS的云服务器类型member，状态置为UNKNOWN。

status

Array of MemberStatus objects

参数解释：后端服务器监听器粒度的的健康状态。

取值范围：不涉及

reason

MemberHealthCheckFailedReason object

参数解释：健康检查异常的原因。

created_at

String

参数解释：创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

取值范围：不涉及

updated_at

String

参数解释：更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

取值范围：不涉及

member_type

String

参数解释：后端服务器的类型。

取值范围：

• ip：IP类型的member。

• instance：关联到ECS的member。

instance_id

String

参数解释：member关联的实例ID。空表示member关联的实例为非真实设备 （如：跨VPC场景）

取值范围：不涉及

listener_id

String

参数解释：监听器ID

取值范围：不涉及

operating_status

String

参数解释：后端服务器的健康状态。

取值范围：

• ONLINE：后端服务器正常。

• NO_MONITOR：后端服务器所在的服务器组没有健康检查器。

• OFFLINE：后端服务器关联的ECS服务器不存在或已关机。

• INITIAL：后端云服务器健康检查打开时的初始状态。

• UNKNOWN: 后端云服务器组没有绑定监听器或者后端云服务器没有关联ECS等原因，后端云服务器健康检查结果未知。

reason

MemberHealthCheckFailedReason object

参数解释：后端服务器的健康状态。

created_at

String

参数解释：创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

取值范围：不涉及

updated_at

String

参数解释：更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

取值范围：不涉及

reason_code

String

参数解释：健康检查异常原因码。

取值范围：

• CONNECT_TIMEOUT: 负载均衡健康检查时向后端服务器建立连接超时。

• CONNECT_REFUSED: 负载均衡健康检查时向后端服务器拒绝连接。

• CONNECT_FAILED: 负载均衡健康检查时向后端服务器建立连接失败。

• CONNECT_INTERRUPT: 负载均衡健康检查与后端服务器连接中断。

• SSL_HANDSHAKE_ERROR: 负载均衡健康检查时与后端服务器SSL握手失败。

• RECV_RESPONSE_FAILED: 负载均衡健康检查时从后端服务器接收响应失败。

• RECV_RESPONSE_TIMEOUT: 负载均衡健康检查时从后端服务器接收响应超时。

• SEND_REQUEST_FAILED: 负载均衡健康检查时向后端服务器发送请求失败。

• SEND_REQUEST_TIMEOUT: 负载均衡健康检查时向后端服务器发送请求超时。

• RESPONSE_FORMAT_ERROR: 负载均衡健康检查时从后端服务器接收响应格式错误。

• RESPONSE_MISMATCH: 负载均衡健康检查时从后端服务器接收的响应码与预期配置返回码不一致。

expected_response

String

参数解释：健康检查预期响应状态码。支持HTTP,HTTPS,GRPC健康检查。只有reason_code为RESPONSE_MISMATCH时，支持非null取值。

取值范围：

• 单值：单个返回码。当type为GRPC时，取值范围为0-99；当type为其他协议时，取值范围为200-599。例如："0"或"200"。

• 列表：多个特定返回码，逗号分隔，最多支持5个返回码。例如:"200,202"或"0,1"。

• 区间：一个返回码区间，区间内"-"分隔，区间之间逗号分隔，最多支持5个区间。例如"200-204,300-399"或"0-5,10-12,20-30"。

healthcheck_response

String

参数解释：健康检查探测实际响应状态码。支持HTTP,HTTPS,GRPC健康检查。只有reason_code为RESPONSE_MISMATCH时，支持非null取值。

取值范围：

• 单个返回码。当type为GRPC时，取值范围为0-99；当type为其他协议时，取值范围为200-599。例如："0"或"200"。

201

POST操作正常返回。