华为云用户手册

响应消息 表3 响应参数 参数 参数类型 描述 id String SSL证书ID。 tenant_id String SSL证书所在的项目ID。 支持的最大字符长度：255 admin_state_up Boolean SSL证书的管理状态； 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 name String SSL证书名称。 支持的最大字符长度：255 description String 证书描述SSL证书描述。 支持的最大字符长度：255 type String SSL证书的类型。 取值范围： server：服务端证书； client：客户端证书； domain String 服务端证书所签 域名 。 支持的最大字符长度：100 private_key String PEM格式的服务端私有密钥。 certificate String PEM格式的服务端公有密钥或者用于认证客户端证书的CA证书，由type字段区分。 expire_time String SSL证书的过期时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS create_time String SSL证书的创建时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS update_time String SSL证书的更新时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS

响应示例 状态码： 200 操作正常返回。 { "request_id" : "46d0dcbec23987f1429491731dce0feb", "ipgroup" : { "id" : "353d6c3b-aca0-40b7-a059-fad8b20419e7", "name" : "test_ipg", "project_id" : "060576798a80d5762fafc01a9b5eedc7", "description" : "", "ip_list" : [ { "ip" : "192.168.1.120", "description" : "test update ip0" }, { "ip" : "192.168.1.122", "description" : "test update ip2" }, { "ip" : "192.168.1.123", "description" : "test" } ], "listeners" : [ { "id" : "acef0c4d-3bd5-4cd0-8d83-c53e5b1fd652" }, { "id" : "edb23879-5511-4412-8b7b-9574de7a1295" } ], "created_at" : "2021-11-29T10:40:30Z", "updated_at" : "2022-12-05T13:14:01Z" } }

请求示例 更新IP地址组的IP列表 PUT https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0/iplist/create-or-update { "ipgroup" : { "name" : "test_ipg", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "test" }, { "ip" : "192.168.1.120", "description" : "test update ip0" } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String IAM 鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ipgroup 否 UpdateIpListOption object 更新IP地址组IP列表请求参数。 表4 UpdateIpListOption 参数 是否必选 参数类型 描述 name 否 String IP地址组的名称 ip_list 否 Array of UpadateIpGroupIpOption objects IP地址组中包含的IP列表。 description 否 String IP地址组的描述信息 表5 UpadateIpGroupIpOption 参数 是否必选 参数类型 描述 ip 是 String IP地址。支持IPv4、IPv6。若传入IP地址不存在，则新增；否则更新已有IP地址的描述信息。 description 否 String 备注信息。 最小长度：0 最大长度：255

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 ipgroup IpGroup object IP地址组信息。 request_id String 请求ID。 注：自动生成 。 表7 IpGroup 参数 参数类型 描述 created_at String IP地址组的创建时间。 description String IP地址组的描述信息。 id String IP地址组的ID。 ip_list Array of IpInfo objects IP地址组中包含的IP或网段列表。[]表示任意IP。 数组长度：0 - 300 listeners Array of ListenerRef objects 与IP地址组关联的监听器的ID列表。 name String IP地址组的名称。 project_id String IP地址组的项目ID。 updated_at String IP地址组的更新时间。 表8 IpInfo 参数 参数类型 描述 ip String IP地址组中的IP地址。 description String IP地址组中ip的备注信息 最小长度：0 最大长度：255 表9 ListenerRef 参数 参数类型 描述 id String 监听器ID。

URI DELETE /v2/{project_id}/elb/listeners/{listener_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 listener_id 是 String 监听器ID。 cascade 否 boolean 删除监听器且级联删除其下子资源（删除监听器、转发策略等，解绑后端服务器）。

请求示例 批量更新转发策略优先级 POST https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/l7policies/batch-update-priority { "l7policies" : [ { "id" : "1fe93e12-6e07-47a9-8f81-3346c015601d", "priority" : 11 } ] }

购买弹性公网IP 接口格式 方法 URI 说明 POST /v1/{tenant_id}/publicips 申请弹性公网IP 具体步骤 设置请求消息头。 在Postman中设置好头部信息，将获取到的Token放入头部，如下图所示。 图1 设置请求消息头-创建公网负载均衡器 在Body标签中填写请求消息体。 图2 填写请求消息体-创建公网负载均衡器 填写URL。 https://vpc.cn-east-2.myhuaweicloud.com/v1/0d0bf0e8fb564cc9abbe526dbdca9248/publicips 发送请求。选择请求方法为POST，点击Send按钮，得到服务端响应 { "publicip": { "id": "73c079fc-357a-4d34-8ba1-818a9d9a2aa2", "status": "PENDING_CREATE", "type": "5_sbgp", "public_ip_address": "122.112.235.121", "tenant_id": "0d0bf0e8fb564cc9abbe526dbdca9248", "create_time": "2018-07-11 02:40:32", "bandwidth_size": 0, "enterprise_project_id": "0" } } 请注意，此时响应体中的tenant_id实为web页面上的项目ID。 示例代码 2中所发送的消息体 { "publicip": { "type": "5_sbgp" }, "bandwidth": { "name": "bandwidth_elb", "size": 1, "share_type": "PER", "charge_mode": "traffic" } } 此处的消息体字段和格式等，具体请参考《虚拟私有云API参考》。

响应样例 { "networks": [ { "status": "ACTIVE", "subnets": [], "name": "liudongtest ", "admin_state_up": false, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "60c809cb-6731-45d0-ace8-3bf5626421a9" }, { "status": "ACTIVE", "subnets": [ "132dc12d-c02a-4c90-9cd5-c31669aace04" ], "name": "publicnet", "admin_state_up": true, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "9daeac7c-a98f-430f-8e38-67f9c044e299" }, { "status": "ACTIVE", "subnets": [ "e25189a8-54df-4948-9396-d8291ffc92a0" ], "name": "testnet01", "admin_state_up": true, "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" } ] }

响应示例 响应样例1 { "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "max_retries": 3, "max_retries_down": 5, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] } 响应样例2 { "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200-204,300-302,401", "max_retries": 3, "max_retries_down": 5, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] }

响应消息 表2 响应参数 参数 参数类型 描述 healthmonitors Array 健康检查对象列表。详见表3。 healthmonitors_links Array 健康检查的分页查询中上下页的链接信息。 仅当分页查询时响应体中有该字段。 详见表5。 表3 healthmonitors字段说明 参数 参数类型 描述 id String 健康检查ID。 tenant_id String 健康检查所在的项目ID。 project_id String 此参数和tenant_id参数含义一样，均指健康检查所在的项目ID。 name String 健康检查名称。 支持的最大字符长度：255 delay Integer 健康检查间隔，单位秒，取值范围[1，50]。 max_retries Integer 健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE， 取值范围[1，10]。 max_retries_down Integer 健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE， 取值范围[1，10]。 pools Array 健康检查关联的后端云服务器组的ID列表。 admin_state_up Boolean 健康检查的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 timeout Integer 健康检查超时时间，单位秒，取值范围[1，50]。 说明： 建议该值小于delay的值。 type String 健康检查的类型。 取值范围：TCP、UDP_CONNECT、HTTP。 monitor_port Integer 健康检查端口号，取值范围[1，65535]。 默认为空，表示使用后端云服务器的protocol_port作为健康检查的检查端口。 expected_codes String 期望HTTP响应状态码，指定下列值： 单值，例如200； 列表，例如200，202； 区间，例如200-204。 仅当type为HTTP时生效。 支持的最大字符长度：64 domain_name String 健康检查时，发送的http请求的域名。 仅当type为HTTP时生效。 默认为空，表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头，只能包含数字、字母、’-’、’.’。 例如：www.test.com 支持的最大字符长度：100 url_path String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如：“/test” 支持的最大字符长度：80 http_method String HTTP请求的方法；默认值：GET 取值范围：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明： 该字段为预留字段，暂未启用。 表4 pools字段说明 参数 参数类型 描述 id String 关联的后端服务器组id 表5 healthmonitors_links字段说明 参数 参数类型 描述 href String 健康检查的分页查询中上下页的链接。 rel String 上下页的提示信息。 取值范围：next、previous。next表示href是下一页的url，previous表示href是上一页的url。

请求消息 表1 请求参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID，表示上一页最后一条查询记录的健康检查的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的健康检查个数。如果不设置，则默认不分页查询所有。 page_reverse 否 Boolean 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 id 否 String 健康检查ID。 tenant_id 否 String 健康检查所在的项目ID。 支持的最大字符长度：255 project_id 否 String 此参数和tenant_id参数含义一样，均指健康检查所在的项目ID。 name 否 String 健康检查名称。 支持的最大字符长度：255 delay 否 Integer 健康检查间隔，单位秒，取值范围[1，50]。 max_retries 否 Integer 健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE，取值范围[1，10]。 max_retries_down 否 Integer 健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE，取值范围[1，10]。 admin_state_up 否 Boolean 健康检查的管理状态。 该字段为预留字段，暂未启用。默认为true。 timeout 否 Integer 健康检查超时时间，单位秒，取值范围[1，50]。 说明： 建议该值小于delay的值。 type 否 String 健康检查的类型。 取值范围：TCP、UDP_CONNECT、HTTP。 monitor_port 否 Integer 健康检查端口号。 默认为空，表示使用后端云服务器的protocol_port作为健康检查的检查端口。 expected_codes 否 String 期望HTTP响应状态码，指定下列值： 单值，例如200； 列表，例如200，202； 区间，例如200-204。 仅当type为HTTP时生效。 支持的最大字符长度：64 说明： 该字段为预留字段，暂未启用。 domain_name 否 String 健康检查时，发送的http请求的域名。 仅当type为HTTP时生效。 默认为空，表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头，只能包含数字、字母、’-’、’.’。 例如：www.test.com 支持的最大字符长度：100 url_path 否 String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如：“/test” 支持的最大字符长度：80 http_method 否 String HTTP请求的方法；默认值：GET 取值范围：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明： 该字段为预留字段，暂未启用。

响应示例 响应样例 { "statuses": { "loadbalancer": { "name": "lb-jy", "provisioning_status": "ACTIVE", "listeners": [ { "name": "listener-jy-1", "provisioning_status": "ACTIVE", "pools": [ { "name": "pool-jy-1", "provisioning_status": "ACTIVE", "healthmonitor": { "type": "TCP", "id": "7422b51a-0ed2-4702-9429-4f88349276c6", "name": "", "provisioning_status": "ACTIVE" }, "members": [ { "protocol_port": 80, "address": "192.168.44.11", "id": "7bbf7151-0dce-4087-b316-06c7fa17b894", "operating_status": "ONLINE", "provisioning_status": "ACTIVE" } ], "id": "c54b3286-2349-4c5c-ade1-e6bb0b26ad18", "operating_status": "ONLINE" } ], "l7policies": [], "id": "eb84c5b4-9bc5-4bee-939d-3900fb05dc7b", "operating_status": "ONLINE" } ], "pools": [ { "name": "pool-jy-1", "provisioning_status": "ACTIVE", "healthmonitor": { "type": "TCP", "id": "7422b51a-0ed2-4702-9429-4f88349276c6", "name": "", "provisioning_status": "ACTIVE" }, "members": [ { "protocol_port": 80, "address": "192.168.44.11", "id": "7bbf7151-0dce-4087-b316-06c7fa17b894", "operating_status": "ONLINE", "provisioning_status": "ACTIVE" } ], "id": "c54b3286-2349-4c5c-ade1-e6bb0b26ad18", "operating_status": "ONLINE" } ], "id": "38278031-cfca-44be-81be-a412f618773b", "operating_status": "ONLINE" } } }

响应消息 表2 响应参数 参数 参数类型 描述 statuses Statuses object 负载均衡器状态树。详见表3。 表3 statuses字段说明 参数 参数类型 描述 loadbalancer Loadbalancer object 负载均衡器对象。详见表4。 表4 loadbalancer字段说明 参数 参数类型 描述 id String 负载均衡器ID。 name String 负载均衡器名称。 支持的最大字符长度：255 listeners Array of Listeners objects 负载均衡器关联的监听器列表。listeners对象参考表5。 pools Array of Pools objects 负载均衡器关联的后端服务器组列表。pools对象参考表6。 operating_status String 该字段为预留字段，目前暂未使用。 负载均衡器的操作状态。取值范围： ONLINE：创建时的默认状态，表示负载均衡器正常。 DEGRADED：该负载均衡器下存在l7policy或l7rule的Provisioning_status为ERROR时返回此状态。注意该状态仅在当前接口中返回。 DISABLED：负载均衡器的admin_state_up属性值为false时会返回该状态。注意该状态仅在当前接口中返回。 FROZEN：负载均衡器被冻结。 provisioning_status String 该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 表5 listeners字段说明 参数 参数类型 描述 id String 监听器ID。 name String 监听器名称。 l7policies Array of l7policies objects 监听器关联的转发策略列表，l7policy对象参考表9。 pools Array of Pools objects 监听器关联的后端云服务器组列表，pools对象参考表6。 operating_status String 监听器的操作状态。取值范围：ONLINE 表示监听器正常。 provisioning_status String 该字段为预留字段，暂未启用。 监听器的配置状态。取值范围：可以为ACTIVE。 表6 pools字段说明 参数 参数类型 描述 id String 后端服务器组ID。 name String 后端服务器组名称。 healthmonitor Healthmonitor object 后端服务器组的健康检查详情，健康检查对象参考表7。 members Array of Members objects 后端服务器组中包含的后端服务器列表，后端服务器对象参考表8。 operating_status String 后端服务器组的操作状态。取值范围：ONLINE 表示后端服务器组正常。 provisioning_status String 该字段为预留字段，暂未启用。 后端服务器组的配置状态。取值范围：可以为ACTIVE。 表7 healthmonitor字段说明 参数 参数类型 描述 id String 健康检查ID。 name String 健康检查名称。 type String 健康检查类型。 取值范围：UDP_CONNECT、TCP、HTTP。 provisioning_status String 该字段为预留字段，暂未启用。 健康检查的配置状态。取值范围：可以为ACTIVE。 表8 members字段说明 参数 参数类型 描述 id String 后端云服务器ID。 address String 后端云服务器的IP地址。 例如："192.168.3.11"。 protocol_port Integer 后端服务器的端口号。 取值范围：[0,65535]。 operating_status String 后端云服务器的操作状态。取值范围： ONLINE：后端服务器正常运行。 NO_MONITOR：后端服务器无健康检查。 DISABLED：后端服务器不可用。所属负载均衡器、后端服务器组或该后端服务器的admin_state_up=false时，会显示该状态。注意该状态仅在当前接口中返回。 OFFLINE：关联的E CS 已下线。 说明： 该接口中的operating_status不一定与对应资源的operating_status相同。如：当Member的admin_state_up=false且operating_status=OFFLINE时，该接口返回member的operating_status=DISABLE。 provisioning_status String 该字段为预留字段，暂未启用。 后端服务器的配置状态。取值范围：可以为ACTIVE。 表9 l7policies字段说明 参数 参数类型 描述 id String 转发策略ID。 name String 转发策略名称。 rules Array of Rules objects 转发策略关联的转发规则列表，转发规则字段参考表10。 action String 转发策略的转发动作； 取值范围：REDIRECT_TO_POOL：转发到后端服务器组，REDIRECT_TO_LISTENER：重定向到监听器。 provisioning_status String 该字段为预留字段，暂未启用。 转发策略的配置状态。取值范围： ACTIVE：默认值，表示正常。 ERROR：表示当前策略与同一监听器下的其他策略存在相同的规则配置。 表10 rules字段说明 参数 参数类型 描述 id String 转发规则ID。 type String 转发规则的匹配内容。 取值范围：PATH或者HOST_NAME。PATH：匹配请求中的路径，HOST_NAME：匹配请求中的域名。 provisioning_status String 该字段为预留字段，暂未启用。 转发规则的配置状态。取值范围： ACTIVE：默认值，表示正常。 ERROR：表示当前规则所属策略与同一监听器下的其他策略存在相同的规则配置。

响应示例 响应样例 { "member": { "name": "member-jy-tt-1", "weight": 1, "admin_state_up": true, "subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503", "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "address": "192.168.44.11", "protocol_port": 88, "operating_status": "ONLINE", "id": "c0042496-e220-44f6-914b-e6ca33bab503" } }

请求示例 请求样例 更新后端云服务器的名称和权重 PUT https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members/c0042496-e220-44f6-914b-e6ca33bab503 { "member": { "name": "member create test", "weight": 10 } }

响应消息 表4 响应参数 参数 参数类型 描述 member Member object member对象。详见表5。 表5 member字段说明 参数 参数类型 描述 id String 后端云服务器的 ID。 说明： 此处并非服务器的ID，而是ELB添加后端服务器之后自动生成的member ID。 tenant_id String 后端云服务器所在的项目ID。 支持的最大字符长度：255 project_id String 此参数和tenant_id参数含义一样，均指后端云服务器所在的项目ID。 name String 后端云服务器的名称。 支持的最大字符长度：255 address String 后端云服务器对应的IP地址，该IP必须在subnet_id字段指定子网的网段中，例如192.168.3.11。 只能对应主网卡的IP。 支持的最大字符长度：64 protocol_port Integer 后端端口的协议号，取值范围[1，65535]。 subnet_id String 后端云服务器所在的子网ID。后端云服务器的IP地址在该子网的网段中。 不支持开启了ipv6的子网。 admin_state_up Boolean 后端云服务器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 weight Integer 后端云服务器的权重，取值范围[0，100]。 权重为0的后端不再接受新的请求。默认为1。 operating_status String 后端云服务器的健康状态，取值： ONLINE，后端服务器正常运行。 NO_MONITOR，后端服务器无健康检查。 OFFLINE，已下线。

URI PUT /v2/{project_id}/elb/pools/{pool_id}/members/{member_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 pool_id 是 String 后端云服务器组id。 member_id 是 String 后端云服务器id。 说明： 此处并非服务器的ID，而是ELB添加后端服服务器之后自动生成的member ID。 memberID可以通过查询后端云服务器列表接口获取。

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 member 是 Member object 后端云服务器对象。详见表3。 表3 member字段说明 参数 是否必选 参数类型 描述 name 否 String 后端云服务器的名称。 支持的最大字符长度：255 admin_state_up 否 Boolean 后端云服务器的管理状态。 该字段为预留字段，暂未启用。默认为true。 weight 否 Integer 后端云服务器的权重，取值范围[0，100]。 权重为0的后端不再接受新的请求。默认为1。

响应示例 响应样例 { "pool": { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "6f52004c-3fe9-4c09-b8ce-ed9d9c74a3b1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "6e29b2cd-4e53-40f6-ae7b-29e918de67f2" } ], "members": [], "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", "name": "my-pool" } }

响应消息 表2 响应参数 参数 参数类型 描述 pool Object 后端云服务器组对象。详见表3 表3 pools字段说明 参数 参数类型 描述 id String 后端云服务器组 ID。 tenant_id String 后端云服务器组所属的项目 ID。 支持的最大字符长度：255 project_id String 此参数和tenant_id参数含义一样，均指后端云服务器组所属的项目 ID。 name String 后端云服务器组名称。 支持的最大字符长度：255 description String 后端云服务器组的描述信息。 支持的最大字符长度：255 protocol String 后端云服务器组的后端协议。 取值范围：TCP、UDP和HTTP。 当指定listener_id创建后端云服务器组时，后端云服务器组的protocol和它关联的监听器的protocol有如下关系： 监听器的protocol为UDP时，后端云服务器组的protocol必须为UDP； 监听器的protocol为TCP时，后端云服务器组的protocol必须为TCP； 监听器的protocol为HTTP或TERMINATED_HTTPS时，后端云服务器组的protocol必须为HTTP。 lb_algorithm String 后端云服务器组的负载均衡算法。 取值范围： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 members Array 后端云服务器组关联的后端云服务器ID的列表。 healthmonitor_id String 后端云服务器组关联的健康检查的ID。 admin_state_up Boolean 后端云服务器组的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 listeners Array 后端云服务器组关联的监听器ID列表。 loadbalancers Array 后端云服务器组关联的负载均衡器ID列表。 session_persistence Object 后端云服务器组的会话持久性。详见表9。 当开启会话保持后，在一定时间内，来自同一客户端的请求会发送到同一个后端云服务器上。 取值范围：当会话保持关闭时，该字段取值为null。 表4 members字段说明 参数 参数类型 描述 id String 关联的后端服务器id 表5 listeners字段说明 参数 参数类型 描述 id String 关联的后端服务器组id 表6 loadbalancers字段说明 参数 参数类型 描述 id String 关联的负载均衡器id 表7 session_persistence字段说明 参数 参数类型 描述 type String 会话保持的类型。 取值范围： SOURCE_IP：根据请求的源IP，将同一IP的请求发送到同一个后端云服务器上。 HTTP_COOKIE：客户端第一次发送请求时，负载均衡器自动生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 APP_COOKIE：客户端第一次发送请求时，后端服务器生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 当后端云服务器组的protocol为TCP时，只按SOURCE_IP生效；当后端云服务器组的protocol为HTTP时，只按HTTP_COOKIE、APP_COOKIE生效。 cookie_name String cookie名称。 当会话保持类型是APP_COOKIE时，为必选字段，其它类型时不可指定。 persistence_timeout Integer 会话保持的超时时间。 当type为APP_COOKIE时不生效。 取值范围： [1,60]（分钟）：当后端云服务器组的protocol为TCP、UDP时。 [1,1440]（分钟）：当后端云服务器组的protocol为HTTP、HTTPS时。

响应示例 响应样例1 { "pool": { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "6f52004c-3fe9-4c09-b8ce-ed9d9c74a3b1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "6e29b2cd-4e53-40f6-ae7b-29e918de67f2" } ], "members": [], "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332", "name": "my-pool" } }

响应消息 表2 响应参数 参数 参数类型 描述 pool Pool object 后端云服务器组对象。详见表3 pool字段说明 表3 pool字段说明 参数 参数类型 描述 id String 后端云服务器组 ID。 tenant_id String 后端云服务器组所属的项目 ID。 支持的最大字符长度：255 project_id String 此参数和tenant_id参数含义一样，均指后端云服务器组所属的项目 ID。 name String 后端云服务器组名称。 支持的最大字符长度：255 description String 后端云服务器组的描述信息。 支持的最大字符长度：255 protocol String 后端云服务器组的后端协议。 取值范围：TCP、UDP和HTTP。 当指定listener_id创建后端云服务器组时，后端云服务器组的protocol和它关联的监听器的protocol有如下关系： 监听器的protocol为UDP时，后端云服务器组的protocol必须为UDP； 监听器的protocol为TCP时，后端云服务器组的protocol必须为TCP； 监听器的protocol为HTTP或TERMINATED_HTTPS时，后端云服务器组的protocol必须为HTTP。 lb_algorithm String 后端云服务器组的负载均衡算法。 取值范围： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 members Array of Members objects 后端云服务器组关联的后端云服务器ID的列表。详见表7 healthmonitor_id String 后端云服务器组关联的健康检查的ID。 admin_state_up Boolean 后端云服务器组的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 listeners Array of Listeners objects 后端云服务器组关联的监听器ID列表。详见表8 loadbalancers Array of Loadbalancers objects 后端云服务器组关联的负载均衡器ID列表。详见表9 session_persistence SessionPersistence object 后端云服务器组的会话持久性。详见表10。 当开启会话保持后，在一定时间内，来自同一客户端的请求会发送到同一个后端云服务器上。 取值范围：当会话保持关闭时，该字段取值为null。 表4 members字段说明 参数 参数类型 描述 id String 关联的后端服务器id 表5 listeners字段说明 参数 参数类型 描述 id String 关联的后端服务器组id 表6 loadbalancers字段说明 参数 参数类型 描述 id String 关联的负载均衡器id 表7 session_persistence字段说明 参数 是否必选 参数类型 描述 type 是 String 会话保持的类型。 取值范围： SOURCE_IP：根据请求的源IP，将同一IP的请求发送到同一个后端云服务器上。 HTTP_COOKIE：客户端第一次发送请求时，负载均衡器自动生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 APP_COOKIE：客户端第一次发送请求时，后端服务器生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 当后端云服务器组的protocol为TCP时，只按SOURCE_IP生效；当后端云服务器组的protocol为HTTP时，只按HTTP_COOKIE、APP_COOKIE生效。 cookie_name 否 String cookie名称。支持字母、数字、中划线(-)和下划线(_)，最大长度64个字符。 当会话保持类型是APP_COOKIE时，为必选字段，其它类型时不可指定。 persistence_timeout 否 Integer 会话保持的超时时间。 当type为APP_COOKIE时不生效。 取值范围： [1,60]（分钟）：当后端云服务器组的protocol为TCP、UDP时。 [1,1440]（分钟）：当后端云服务器组的protocol为HTTP、HTTPS时。

请求示例 请求样例 更新后端云服务器的名称和权重 PUT https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members/c0042496-e220-44f6-914b-e6ca33bab503 { "member": { "name": "member create test", "weight": 10 } }

响应示例 响应样例 { "member": { "name": "member-jy-tt-1", "weight": 1, "admin_state_up": true, "subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503", "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "address": "192.168.44.11", "protocol_port": 88, "operating_status": "ONLINE", "id": "c0042496-e220-44f6-914b-e6ca33bab503" } }

URI PUT /v2.0/lbaas/pools/{pool_id}/members/{member_id} 表1 参数说明 参数 是否必选 参数类型 描述 pool_id 是 String 后端云服务器组ID。 member_id 是 String 后端云服务器ID。 说明： 此处并非服务器的ID，而是ELB添加后端服务器之后自动生成的member ID。 memberID可以通过查询后端云服务器接口获取。

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 member 是 Object 后端云服务器对象。详见表3。 表3 member字段说明 参数 是否必选 参数类型 描述 name 否 String 后端云服务器的名称。 支持的最大字符长度：255 admin_state_up 否 Boolean 后端云服务器的管理状态。 该字段为预留字段，暂未启用。默认为true。 weight 否 Integer 后端云服务器的权重，取值范围[0，100]。 权重为0的后端不再接受新的请求。默认为1。

响应消息 表4 响应参数 参数 参数类型 描述 member Object member对象。详见表5。 表5 member字段说明 参数 参数类型 描述 id String 后端云服务器的 ID。 说明： 此处并非服务器的ID，而是ELB添加后端服务器之后自动生成的member ID。 tenant_id String 后端云服务器所在的项目ID。 支持的最大字符长度：255 project_id String 此参数和tenant_id参数含义一样，均指后端云服务器所在的项目ID。 name String 后端云服务器的名称。 支持的最大字符长度：255 address String 后端云服务器对应的IP地址，该IP必须在subnet_id字段指定子网的网段中，例如192.168.3.11。 只能对应主网卡的IP。 支持的最大字符长度：64 protocol_port Integer 后端端口的协议号，取值范围[1，65535]。 subnet_id String 后端云服务器所在的子网ID。后端云服务器的IP地址在该子网的网段中。 不支持开启了ipv6的子网。 admin_state_up Boolean 后端云服务器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 weight Integer 后端云服务器的权重，取值范围[0，100]。 权重为0的后端不再接受新的请求。默认为1。 operating_status String 后端云服务器的健康状态，取值： ONLINE，后端服务器正常运行。 NO_MONITOR，后端服务器无健康检查。 OFFLINE，已下线。

状态码 表1 正常状态码 正常返回码 类型 说明 200 OK GET和PUT操作正常返回。 201 Created POST操作正常返回。 204 No Content DELETE操作正常返回。 表2 错误状态码 错误返回码 类型 可能的错误原因 400 Bad request 请求URI不正确 请求的header超过长度限制 请求体不正确 请求体中包含未上线的特性字段 401 Unauthorized 请求的header中未携带鉴权信息 请求的header中携带的鉴权信息已过期 403 Forbidden 用户无访问API的权限 404 Not Found 请求的URI不存在 请求的资源不存在 405 Method Not Allowed 请求中指定的方法不被允许 406 Not Acceptable 服务器生成的响应无法被客户端所接受 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理 408 Request Timeout 请求超出了服务器的等待时间 409 Conflict 由于冲突，请求无法被完成 请求的资源正在被其他请求处理 500 Internal server error 服务内部错误 服务端异常 501 Not Implemented 请求未完成。服务器不支持所请求的功能 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应 503 Service unavailable 请求未完成。系统暂时异常 504 Gateway Timeout 网关超时 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 ipgroup IpGroup object 查询IP地址组详情的响应体。 request_id String 请求ID。 注：自动生成 。 表4 IpGroup 参数 参数类型 描述 created_at String IP地址组的创建时间。 description String IP地址组的描述信息。 id String IP地址组的ID。 ip_list Array of IpInfo objects IP地址组中包含的IP或网段列表。[]表示任意IP。 数组长度：0 - 300 listeners Array of ListenerRef objects 与IP地址组关联的监听器的ID列表。 name String IP地址组的名称。 project_id String IP地址组的项目ID。 updated_at String IP地址组的更新时间。 表5 IpInfo 参数 参数类型 描述 ip String IP地址组中的IP地址。 description String IP地址组中ip的备注信息 最小长度：0 最大长度：255 表6 ListenerRef 参数 参数类型 描述 id String 监听器ID。