# 创建主备后端服务器组 - CreateMasterSlavePool #### 功能介绍 创建主备后端服务器组。 #### 接口约束 1. 指定session_persistence参数时，只有当type是APP_COOKIE时，才可以设置cookie_name。 2. 若指定listener_id参数，则对应的监听器必须未绑定后端服务器组。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:pools:create | Write | loadbalancer | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | | elb:pools:create | Write | listener | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | | elb:pools:create | Write | pool \* | g:EnterpriseProjectId | - | - | #### URI POST /v3/{project_id}/elb/master-slave-pools 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pool | 是 | [CreateMasterSlavePoolOption] object | **参数解释**：创建pool的请求体。 **约束限制**：网关型LB不支持主备服务器组。 | 表4CreateMasterSlavePoolOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 否 | String | **参数解释**：后端服务器组的描述信息。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | lb_algorithm | 是 | String | **参数解释**：后端服务器组的负载均衡算法。 **约束限制**：不涉及 **取值范围**： - ROUND_ROBIN：加权轮询算法。 - LEAST_CONNECTIONS：加权最少连接算法。 - SOURCE_IP：源IP算法。 - QUIC_CID：连接ID算法。 **默认取值**：不涉及 | | loadbalancer_id | 否 | String | **参数解释**：后端服务器组关联的LB的ID。 **约束限制**：listener_id，loadbalancer_id，type至少指定一个。 **取值范围**：不涉及 **默认取值**：不涉及 | | listener_id | 否 | String | **参数解释**：后端服务器组关联的监听器的ID。 **约束限制**：listener_id，loadbalancer_id，type至少指定一个。 **取值范围**：不涉及 **默认取值**：不涉及 | | name | 否 | String | **参数解释**：后端服务器组的名称。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | project_id | 否 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 说明： 该字段实际无效，最终使用url中的project_id。 | | protocol | 是 | String | **参数解释**：后端服务器组的后端协议。 **约束限制**： - listener的protocol为UDP时，pool的protocol必须为UDP或QUIC。 - listener的protocol为TCP时，pool的protocol必须为TCP。 - listener的protocol为TLS时，pool的protocol必须为TLS或TCP（且只能使用ip_version为v4的TCP pool）。 - 其他协议监听器不支持主备后端服务器组。 **取值范围**：TCP、UDP、QUIC、TLS。 **默认取值**：不涉及 | | session_persistence | 否 | [CreatePoolSessionPersistenceOption] object | **参数解释**：会话持久性对象。 **约束限制**：慢启动与会话保持不能同时开启。若都开启则会导致会话保持失效。 | | vpc_id | 否 | String | **参数解释**：后端服务器组关联的虚拟私有云的ID。 **约束限制**： - 只能挂载到该虚拟私有云下。 - 只能添加该虚拟私有云下的后端服务器或跨VPC的后端服务器。 - type必须指定为instance。 - pool的protocol为IP时，必须指定vpc_id，且与LB的vpc_id相同。 - 若未指定vpc_id，则后续添加后端服务器时，vpc_id由后端服务器所在的虚拟私有云确定。 **取值范围**：不涉及 **默认取值**：不涉及 | | type | 是 | String | **参数解释**：后端服务器组的类型。 **约束限制**：不涉及 **取值范围**： - instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 - ip：只能添加IP类型后端，type指定为该类型时，vpc_id不允许指定。 **默认取值**：不涉及 | | ip_version | 否 | String | **参数解释**：后端服务器组支持的IP版本。 **约束限制**：不涉及 **取值范围**： - 共享型：固定为v4； - 独享型：取值dualstack、v4。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。当协议为HTTP时，ip_version为v4。 **默认取值**：不涉及 | | members | 是 | Array of [CreateMasterSlaveMemberOption] objects | **参数解释**：主备服务器组的后端服务器。 **约束限制**：只能添加2个后端服务器，必须有一个为主，一个为备。 | | healthmonitor | 是 | [CreateMasterSlaveHealthMonitorOption] object | **参数解释**：主备服务器组的健康检查。默认开启健康检查，无法关闭。 **约束限制**：不涉及 | | any_port_enable | 否 | Boolean | **参数解释**：后端是否开启全端口转发。开启后，后端服务器端口与前端监听器端口保持一致。关闭后，请求会转发给后端服务器protocol_port字段指定端口。 **约束限制**：仅QUIC,TCP,UDP的pool支持。 **取值范围**：false 不开启，true 开启。 **默认取值**：不涉及 | | connection_drain | 否 | [ConnectionDrain] object | **参数解释**：后端服务器的延迟注销的功能配置。 以下场景会触发： - 后端服务器从后端服务器组中移除。 - 后端服务器健康检查状态异常。 - 后端服务器权重修改为0。 **约束限制**：只针对TCP、UDP、QUIC协议类型的后端服务器组和TCP、UDP协议类的监听器。 | | quic_cid_hash_strategy | 否 | [QuicCidHashStrategy] object | **参数解释**：后端服务器组基于部分DST CID的多径分发策略配置。 **约束限制**：不涉及 | | enterprise_project_id | 否 | String | **参数解释**：资源所属的企业项目ID。创建时不传则资源属于default企业项目，返回enterprise_project_id="0"。 **约束限制**：不能传入空字符串""或不存在的企业项目ID。 **取值范围**：不涉及 **默认取值**："0" | | public_border_group | 否 | String | **参数解释**：公网边界组。 **约束限制**：不涉及 **取值范围**： - center：表示中心站点的公网边界组 - 边缘站点名称：表示边缘站点的公网边界组 **默认取值**：不涉及 | 表5CreatePoolSessionPersistenceOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cookie_name | 否 | String | **参数解释**：cookie名称。 **约束限制**： - 只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。 - 网关型LB，不支持该特性，请勿使用。 **取值范围**：最大长度1024个字符。 **默认取值**：不涉及 | | type | 是 | String | **参数解释**：会话保持类型。 **约束限制**： - 当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效； - 当pool的protocol为HTTP、HTTPS时。type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。 - 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。 **取值范围**： - SOURCE_IP：基于源IP地址的会话保持，也就是根据客户端的源IP地址将流量持续转发到同一后端服务器（member）。 - HTTP_COOKIE：通过在HTTP响应中插入一个特殊的Cookie，实现会话保持。负载均衡会在后续请求中识别该Cookie，并将请求转发到对应的后端服务器。 - APP_COOKIE：基于应用层Cookie的会话保持。与HTTP_COOKIE不同的是，APP_COOKIE要求后端服务在响应中插入一个指定名称的Cookie，负载均衡器识别后，将后续请求转发到相同后端member。 **默认取值**：不涉及 | | persistence_timeout | 否 | Integer | **参数解释**：会话保持的时间。 **约束限制**：当type为APP_COOKIE时不生效。 **取值范围**： - 若pool的protocol为TCP、UDP则范围为\[1,60\]（分钟），默认值1； - 若pool的protocol为HTTP和HTTPS则范围为\[1,1440\]（分钟），默认值1440。 **默认取值**：不涉及 | 表6CreateMasterSlaveMemberOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | **参数解释**：后端服务器名称。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | protocol_port | 否 | Integer | **参数解释**：后端服务器业务端口 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 说明： 在开启端口透传的pool下创建member传该字段不生效，可不传该字段。 | | subnet_cidr_id | 否 | String | **参数解释**：后端服务器所在的子网ID，可以是子网的IPv4子网ID或IPv6子网ID。 **约束限制**： - 该子网和关联的负载均衡器的子网必须在同一VPC下。 - 若所属LB的IP类型后端转发特性已开启，则该字段可以不传，表示添加跨VPC的后端服务器。此时address必须为**私网IPv4**地址，所在的pool的协议必须为UDP/TCP/TLS/HTTP/HTTPS/QUIC/GRPC。 **取值范围**：不涉及 **默认取值**：不涉及 | | role | 是 | String | **参数解释**：后端服务器的主备状态。 **约束限制**：不涉及 **取值范围**： - master：主后端服务器。 - slave：备后端服务器。 **默认取值**：不涉及 | 表7CreateMasterSlaveHealthMonitorOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | delay | 是 | Integer | **参数解释**：健康检查间隔。 **约束限制**：不涉及 **取值范围**：1-50，单位：秒。 **默认取值**：不涉及 | | domain_name | 否 | String | **参数解释**：发送健康检查请求的域名。 **约束限制**：当type为HTTP/HTTPS时生效。 **取值范围**：以数字或字母开头，只能包含数字、字母、'-'、'.'。 **默认取值**：null，表示使用负载均衡器的vip作为http请求的目的地址。 | | expected_codes | 否 | String | **参数解释**：期望响应状态码。 **约束限制**：该字段仅在HTTP/HTTPS/GRPC协议下有效，其他协议可以设置但不会生效。 **取值范围**： - 单值：单个返回码，例如200。 - 列表：多个特定返回码，例如200，202。 - 区间：一个返回码区间，例如200-204 **默认取值**：若健康检查type为GRPC，则默认值为0，其他为200。 | | http_method | 否 | String | **参数解释**：HTTP请求方法。 **约束限制**：当type为HTTP/HTTPS时生效。 **取值范围**：GET、HEAD、POST **默认取值**：GET | | max_retries | 是 | Integer | **参数解释**：健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。 **约束限制**：不涉及 **取值范围**：1-10 **默认取值**：不涉及 | | max_retries_down | 否 | Integer | **参数解释**：健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。 **约束限制**：不涉及 **取值范围**：1-10 **默认取值**：3 | | monitor_port | 否 | Integer | **参数解释**：健康检查端口号。 **约束限制**：不涉及 **取值范围**：1-65535 **默认取值**：null，表示使用后端服务器端口号。 | | name | 否 | String | **参数解释**：健康检查名称。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | timeout | 是 | Integer | **参数解释**：一次健康检查请求的超时时间。建议该值小于delay的值。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | type | 是 | String | **参数解释**：健康检查请求协议。 **约束限制**： - 若pool的protocol为QUIC，则type只能是UDP_CONNECT。 - 若pool的protocol为UDP，则type只能UDP_CONNECT。 - 若pool的protocol为TCP，则type可以是TCP、HTTP、HTTPS。 - 若pool的protocol为HTTP，则type可以是TCP、HTTP、HTTPS。 - 若pool的protocol为HTTPS，则type可以是TCP、HTTP、HTTPS。 **取值范围**：TCP、UDP_CONNECT、HTTP、HTTPS。UDP_CONNECT即UDP协议。 **默认取值**：不涉及 | | url_path | 否 | String | **参数解释**：健康检查请求的请求路径，以"/"开头。 **约束限制**：当type为HTTP/HTTPS时生效。 **取值范围**：支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和and（\&）以及扩展字符集_;\~!()\*\[\]@$\^:',+ **默认取值**："/" | 表8ConnectionDrain | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enable | 否 | Boolean | **参数解释**：延迟注销功能开关。 **约束限制**：不涉及 **取值范围**：true 开启，false 关闭。 **默认取值**：不涉及 | | timeout | 否 | Integer | **参数解释**：延迟注销时间。 **约束限制**：不涉及 **取值范围**：10\~4000，单位：秒。 **默认取值**：不涉及 | 表9QuicCidHashStrategy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | len | 是 | Integer | **参数解释**：表示hash的时候取CID的长度。 **约束限制**：仅当负载均衡算法为QUIC_CID的时候才生效。 **取值范围**：1-20 **默认取值**：3 | | offset | 是 | Integer | **参数解释**：表示hash的时候取CID的偏移量。 **约束限制**：仅当负载均衡算法为QUIC_CID的时候才生效。 **取值范围**：0-19 **默认取值**：1 | #### 响应参数 **状态码：201** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | | pool | [MasterSlavePool] object | **参数解释**：后端服务器组对象。 | 表11MasterSlavePool | 参数 | 参数类型 | 描述 | |:---|:---|:---| | description | String | **参数解释**：后端服务器组的描述信息。 **取值范围**：不涉及 | | id | String | **参数解释**：后端服务器组的ID。 **取值范围**：不涉及 | | lb_algorithm | String | **参数解释**：后端服务器组的负载均衡算法。 **取值范围**： - ROUND_ROBIN：加权轮询算法。 - LEAST_CONNECTIONS：加权最少连接算法。 - SOURCE_IP：源IP算法。 - QUIC_CID：连接ID算法。 | | listeners | Array of [ListenerRef] objects | **参数解释**：后端服务器组关联的监听器ID列表。 | | loadbalancers | Array of [LoadBalancerRef] objects | **参数解释**：后端服务器组关联的负载均衡器ID列表。 | | members | Array of [MasterSlaveMember] objects | **参数解释**：后端服务器组中的后端服务器列表。 | | name | String | **参数解释**：后端服务器组的名称。 **取值范围**：不涉及 | | project_id | String | **参数解释**：后端服务器组所在的项目ID。 **取值范围**：不涉及 | | protocol | String | **参数解释**：后端服务器组的后端协议。 **取值范围**：不涉及TCP、UDP、QUIC、TLS。 | | session_persistence | [SessionPersistence] object | **参数解释**：会话持久性对象。 | | ip_version | String | **参数解释**：后端服务器组支持的IP版本。 **取值范围**： - 共享型：固定为v4； - 独享型：取值dualstack、v4。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。当协议为HTTP时，ip_version为v4。 | | 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 | **参数解释**：后端服务器组的类型。 **取值范围**：不涉及 - instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 - ip：只能添加IP类型后端，type指定为该类型时，vpc_id不允许指定。 - 空字符串（""）：允许任意类型的后端 | | enterprise_project_id | String | **参数解释**：资源所属的企业项目ID。 **取值范围**： - "0"：表示资源属于default企业项目。 - UUID格式的字符串，表示非默认企业项目。 | | healthmonitor | [MasterSlaveHealthMonitor] object | **参数解释**：后端服务器组的健康检查。 | | any_port_enable | Boolean | **参数解释**：后端是否开启全端口转发。开启后，后端服务器端口与前端监听器端口保持一致。关闭后，请求会转发给后端服务器protocol_port字段指定端口。取值：false 不开启，true 开启。 **取值范围**：不涉及 | | connection_drain | [ConnectionDrain] object | **参数解释**：后端服务器的延迟注销的功能配置。 以下场景会触发： - 后端服务器从后端服务器组中移除。 - 后端服务器健康检查状态异常。 - 后端服务器权重修改为0。 **取值范围**：不涉及 | | quic_cid_hash_strategy | [QuicCidHashStrategy] object | **参数解释**：主备后端服务器组基于部分DST CID的多径分发策略配置。 | | public_border_group | String | **参数解释**：公网边界组。 **取值范围**： - center：表示中心站点的公网边界组 - 边缘站点名称：表示边缘站点的公网边界组 | 表12ListenerRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：监听器ID。 **取值范围**：不涉及 | 表13LoadBalancerRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：负载均衡器ID。 **取值范围**：不涉及 | 表14MasterSlaveMember | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：后端服务器ID。 **取值范围**：不涉及 | | name | String | **参数解释**：后端服务器名称。 **取值范围**：不涉及 | | admin_state_up | Boolean | **参数解释**：后端服务器的管理状态。 虽然创建、更新请求支持该字段，但实际取值决定于后端服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。 **取值范围**：true、false。 | | subnet_cidr_id | String | **参数解释**：后端服务器所在子网的IPv4子网ID或IPv6子网ID。 若所属的LB的IP类型后端转发特性已开启，则该字段可以不传，表示添加IP类型的后端服务器。此时address必须为**私网IPv4**地址，所在的pool的协议必须为UDP/TCP/TLS/HTTP/HTTPS/QUIC/GRPC。 **取值范围**：不涉及 | | protocol_port | Integer | **参数解释**：后端服务器业务端口。 说明： 在开启端口透传的pool下创建member传该字段不生效，可不传该字段。 | | address | String | **参数解释**：后端服务器对应的IP地址。 **取值范围**：不涉及 | | ip_version | String | **参数解释**：当前后端服务器的IP地址版本，由后端系统自动根据传入的address字段确定。 **取值范围**：v4、v6 | | device_owner | String | **参数解释**：设备所有者。 **取值范围**：不涉及 - 空，表示后端服务器未关联到ECS。 - compute:{az_name}，表示关联到ECS，其中{az_name}表示ECS所在可用区名。 - compute:subeni，表示辅助弹性网卡。 不支持该字段，请勿使用。 | | device_id | String | **参数解释**：关联的ECS ID，为空表示后端服务器未关联到ECS。 **取值范围**：不涉及 不支持该字段，请勿使用。 | | operating_status | String | **参数解释**：后端服务器的健康状态。 **取值范围**：不涉及 - ONLINE：后端服务器正常。 - NO_MONITOR：后端服务器所在的服务器组没有健康检查器。 - OFFLINE：后端服务器关联的ECS服务器不存在或已关机。 - INITIAL：后端云服务器健康检查打开时的初始状态。 - UNKNOWN: 后端云服务器组没有绑定监听器或者后端云服务器没有关联ECS等原因，后端云服务器健康检查结果未知。 | | reason | [MemberHealthCheckFailedReason] object | **参数解释**：健康检查异常的原因。 | | member_type | String | **参数解释**：后端服务器的类型。 **取值范围**： - ip：IP类型的member。 - instance：关联到ECS的member。 | | instance_id | String | **参数解释**：member关联的实例ID。空表示member关联的实例为非真实设备 （如：IP类型的后端场景）。 **取值范围**：不涉及 | | role | String | **参数解释**：后端服务器的主备状态。 **取值范围**：不涉及 | | status | Array of [ListenerMemberInfo] objects | **参数解释**：后端服务器监听器粒度的健康状态。 若绑定的监听器在该字段中，则以该字段中监听器对应的operating_status为准。 若绑定的监听器不在该字段中，则以外层的operating_status为准。 **取值范围**：不涉及 | 表15MemberHealthCheckFailedReason | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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"。 | 表16ListenerMemberInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | listener_id | String | **参数解释**：后端服务器关联的监听器ID。 **取值范围**：不涉及 | | operating_status | String | **参数解释**：后端服务器的健康状态。 **取值范围**： - ONLINE：后端服务器正常。 - NO_MONITOR：后端服务器所在的服务器组没有健康检查器。 - OFFLINE：后端服务器关联的ECS服务器不存在或已关机或服务异常。 - INITIAL：后端云服务器健康检查打开时的初始状态。 - UNKNOWN: 后端云服务器组没有绑定监听器或者后端云服务器没有关联ECS等原因，后端云服务器健康检查结果未知。 | 表17SessionPersistence | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cookie_name | String | **参数解释**：cookie名称。 **取值范围**：最大长度1024个字符。 | | type | String | **参数解释**：会话保持类型。 **取值范围**： - SOURCE_IP：基于源IP地址的会话保持，也就是根据客户端的源IP地址将流量持续转发到同一后端服务器（member）。 - HTTP_COOKIE：通过在HTTP响应中插入一个特殊的Cookie，实现会话保持。负载均衡会在后续请求中识别该Cookie，并将请求转发到对应的后端服务器。 - APP_COOKIE：基于应用层Cookie的会话保持。与HTTP_COOKIE不同的是，APP_COOKIE要求后端服务在响应中插入一个指定名称的Cookie，负载均衡器识别后，将后续请求转发到相同后端member。 | | persistence_timeout | Integer | **参数解释**：会话保持的时间。当type为APP_COOKIE时不生效。 **取值范围**： - 若pool的protocol为TCP、UDP和QUIC则范围为\[1,60\]（分钟），默认值1。 - 若pool的protocol为HTTP和HTTPS则范围为\[1,1440\]（分钟），默认值1440。 | 表18MasterSlaveHealthMonitor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | admin_state_up | Boolean | **参数解释**：健康检查的管理状态。 **取值范围**： - true：表示开启健康检查。 - false表示关闭健康检查。 | | delay | Integer | **参数解释**：健康检查间隔。 **取值范围**：1-50，单位：秒。 | | domain_name | String | **参数解释**：发送健康检查请求的域名。 **取值范围**：以数字或字母开头，只能包含数字、字母、'-'、'.'。 | | expected_codes | String | **参数解释**：期望响应状态码。 **取值范围**： - 单值：单个返回码，例如200。 - 列表：多个特定返回码，例如200，202。 - 区间：一个返回码区间，例如200-204。 | | http_method | String | **取值范围**：GET、HEAD、POST | | id | String | **参数解释**：健康检查ID **取值范围**：不涉及 | | max_retries | Integer | **参数解释**：健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。 **取值范围**：1-10 | | max_retries_down | Integer | **参数解释**：健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。 **取值范围**：1-10 | | monitor_port | Integer | **参数解释**：健康检查端口号。 **取值范围**：1-65535 | | name | String | **参数解释**：健康检查名称。 **取值范围**：不涉及 | | timeout | Integer | **参数解释**：一次健康检查请求的超时时间。 **取值范围**：不涉及 | | type | String | **参数解释**：健康检查请求协议。 **取值范围**：TCP、UDP_CONNECT、HTTP、HTTPS。UDP_CONNECT即UDP协议。 | | url_path | String | **参数解释**：健康检查请求的请求路径。以"/"开头，默认为"/"。 **取值范围**：支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和and（\&）以及扩展字符集_;\~!()\*\[\]@$\^:',+ | 表19ConnectionDrain | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enable | Boolean | **参数解释**：延迟注销功能开关。 **取值范围**：true 开启，false 关闭。 | | timeout | Integer | **参数解释**：延迟注销时间。 **取值范围**：10\~4000，单位：秒。 | 表20QuicCidHashStrategy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | len | Integer | **参数解释**：表示hash的时候取CID的长度。 **取值范围**：1-20 | | offset | Integer | **参数解释**：表示hash的时候取CID的偏移量。 **取值范围**：0-19 | #### 请求示例 ``` POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/master-slave-pools { "pool" : { "name" : "My pool", "lb_algorithm" : "LEAST_CONNECTIONS", "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193", "protocol" : "TCP", "type" : "ip", "members" : [ { "protocol_port" : 89, "name" : "My member", "address" : "120.10.10.16", "role" : "master" }, { "protocol_port" : 89, "address" : "110.4.10.16", "role" : "slave" } ], "healthmonitor" : { "name" : "My Healthmonitor", "max_retries" : 3, "type" : "HTTP", "timeout" : 30, "delay" : 1 } } } ``` #### 响应示例 **状态码：201** 操作正常返回。 ``` { "pool" : { "name" : "master-slave-pool", "id" : "060dac1a-a139-4628-9b27-eee5930f7104", "description" : "", "lb_algorithm" : "ROUND_ROBIN", "protocol" : "TCP", "loadbalancers" : [ { "id" : "696b9e7b-910f-4fbd-8d17-f9cb49fd222c" } ], "type" : "instance", "project_id" : "0c1503d710984bad92306faea3654dfd", "session_persistence" : null, "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" } ], "members" : [ { "admin_state_up" : false, "address" : "192.168.255.56", "protocol_port" : 80, "id" : "b9ceb848-9715-4500-9463-72033151ed9a", "operating_status" : "OFFLINE", "status" : [ { "listener_id" : "0b11747a-b139-492f-9692-2df0b1c87193", "operating_status" : "OFFLINE" } ], "reason" : null, "instance_id" : "", "device_id" : "", "device_owner" : "", "member_type" : "instance", "role" : "master", "ip_version" : "v4", "name" : "", "subnet_cidr_id" : "b7e1fb40-74fd-4235-a83c-e0a07a9f2f44" }, { "admin_state_up" : false, "address" : "192.168.255.56", "protocol_port" : 81, "id" : "df025ce9-4a04-4249-9b9a-06e35c79436c", "operating_status" : "UNKNOWN", "reason" : null, "instance_id" : "", "device_id" : "", "device_owner" : "", "member_type" : "instance", "role" : "slave", "ip_version" : "v4", "status" : [ ], "name" : "", "subnet_cidr_id" : "b7e1fb40-74fd-4235-a83c-e0a07a9f2f44" } ], "enterprise_project_id" : "0", "ip_version" : "dualstack", "created_at" : "2024-09-11T04:08:02Z", "updated_at" : "2024-09-11T04:08:02Z", "healthmonitor" : { "monitor_port" : null, "id" : "bb84fcd5-a0bf-4516-b99c-d62274f1e28d", "domain_name" : "", "name" : "", "delay" : 5, "max_retries" : 10, "max_retries_down" : 3, "admin_state_up" : true, "timeout" : 50, "type" : "TCP", "expected_codes" : "200", "url_path" : "/", "http_method" : "GET" }, "vpc_id" : "aa8a8149-1ae2-4f22-b035-30046308f1ac", "connection_drain" : null, "quic_cid_hash_strategy" : null, "public_border_group" : "center", "any_port_enable" : false }, "request_id" : "2d974978-0733-404d-a21a-b29204f4803a" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; import java.util.List; import java.util.ArrayList; public class CreateMasterSlavePoolSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); CreateMasterSlavePoolRequest request = new CreateMasterSlavePoolRequest(); CreateMasterSlavePoolRequestBody body = new CreateMasterSlavePoolRequestBody(); CreateMasterSlaveHealthMonitorOption healthmonitorPool = new CreateMasterSlaveHealthMonitorOption(); healthmonitorPool.withDelay(1) .withMaxRetries(3) .withName("My Healthmonitor") .withTimeout(30) .withType("HTTP"); List listPoolMembers = new ArrayList<>(); listPoolMembers.add( new CreateMasterSlaveMemberOption() .withAddress("120.10.10.16") .withName("My member") .withProtocolPort(89) .withRole(CreateMasterSlaveMemberOption.RoleEnum.fromValue("master")) ); listPoolMembers.add( new CreateMasterSlaveMemberOption() .withAddress("110.4.10.16") .withProtocolPort(89) .withRole(CreateMasterSlaveMemberOption.RoleEnum.fromValue("slave")) ); CreateMasterSlavePoolOption poolbody = new CreateMasterSlavePoolOption(); poolbody.withLbAlgorithm("LEAST_CONNECTIONS") .withListenerId("0b11747a-b139-492f-9692-2df0b1c87193") .withName("My pool") .withProtocol("TCP") .withType("ip") .withMembers(listPoolMembers) .withHealthmonitor(healthmonitorPool); body.withPool(poolbody); request.withBody(body); try { CreateMasterSlavePoolResponse response = client.createMasterSlavePool(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = CreateMasterSlavePoolRequest() healthmonitorPool = CreateMasterSlaveHealthMonitorOption( delay=1, max_retries=3, name="My Healthmonitor", timeout=30, type="HTTP" ) listMembersPool = [ CreateMasterSlaveMemberOption( address="120.10.10.16", name="My member", protocol_port=89, role="master" ), CreateMasterSlaveMemberOption( address="110.4.10.16", protocol_port=89, role="slave" ) ] poolbody = CreateMasterSlavePoolOption( lb_algorithm="LEAST_CONNECTIONS", listener_id="0b11747a-b139-492f-9692-2df0b1c87193", name="My pool", protocol="TCP", type="ip", members=listMembersPool, healthmonitor=healthmonitorPool ) request.body = CreateMasterSlavePoolRequestBody( pool=poolbody ) response = client.create_master_slave_pool(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.CreateMasterSlavePoolRequest{} nameHealthmonitor:= "My Healthmonitor" healthmonitorPool := &model.CreateMasterSlaveHealthMonitorOption{ Delay: int32(1), MaxRetries: int32(3), Name: &nameHealthmonitor, Timeout: int32(30), Type: "HTTP", } nameMembers:= "My member" protocolPortMembers:= int32(89) protocolPortMembers1:= int32(89) var listMembersPool = []model.CreateMasterSlaveMemberOption{ { Address: "120.10.10.16", Name: &nameMembers, ProtocolPort: &protocolPortMembers, Role: model.GetCreateMasterSlaveMemberOptionRoleEnum().MASTER, }, { Address: "110.4.10.16", ProtocolPort: &protocolPortMembers1, Role: model.GetCreateMasterSlaveMemberOptionRoleEnum().SLAVE, }, } listenerIdPool:= "0b11747a-b139-492f-9692-2df0b1c87193" namePool:= "My pool" poolbody := &model.CreateMasterSlavePoolOption{ LbAlgorithm: "LEAST_CONNECTIONS", ListenerId: &listenerIdPool, Name: &namePool, Protocol: "TCP", Type: "ip", Members: listMembersPool, Healthmonitor: healthmonitorPool, } request.Body = &model.CreateMasterSlavePoolRequestBody{ Pool: poolbody, } response, err := client.CreateMasterSlavePool(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=CreateMasterSlavePool&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。