华为云用户手册

请求示例 创建一个IP地址组，并指定其中包含的IP地址 POST https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups { "ipgroup" : { "name" : "test_ipg", "ip_list" : [ { "ip" : "192.168.1.123" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" }, { "ip" : "2001:0DB8:02de:0000:0000:0000:0000:0e13" } ] } }

API授权项注意事项 配额显示细粒度权限控制action为elb:quotas:list。 云日志创建、查列表、查详情、更新和删除的细粒度权限控制action为elb:logtanks:create，elb:logtanks:list，elb:logtanks:get，elb:logtanks:put和elb:logtanks:delete。 云日志使用会依赖LTS服务，请在项目（Project）级别赋予lts:*:get*和lts:*:list*权限。 弹性负载均衡的监控功能依赖云监控CES的权限。 父主题： V2API授权项列表

具体步骤 设置请求消息头。Postman中设置好头部信息，将获取到的Token放入头部。 为“/music”开头请求创建转发规则。 POST https://elb.cn-east-2.myhuaweicloud.com/v2.0/lbaas/l7policies/5b94fb42-b018-4ad6-9ba6-0e8a509c6821/rules { "rule": { "compare_type": "STARTS_WITH", "type": "PATH", "value": "/music" } } 为“/pic”开头请求创建转发规则。 POST https://elb.cn-east-2.myhuaweicloud.com/v2.0/lbaas/l7policies/f6c5862d-460c-4ab6-8dc7-2294df442f67/rules { "rule": { "compare_type": "STARTS_WITH", "type": "PATH", "value": "/pic" } } 在相应的转发策略页面，可以看到转发规则已成功配置。

返回码 表1 正常返回码 正常返回码 类型 描述 200 OK GET操作正常返回 POST操作有返回体时正常返回 204 No Content DELETE操作正常返回。 POST操作无返回体时正常返回。 表2 错误码 Http状态码 错误码 说明 Error Message 描述（处理措施） 400 VPC.1801 ID错误。 resource id is invalid/Getting id is invalid. 检查使用正确的Resource ID。 400 VPC.1801 action错误。 action is invalid. 合法的action为create或delete。 400 VPC.1801 key的长度非法。 Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] 检查使用合法的key值。 400 VPC.0007 Project_id错误。 urlTenantId is not equal token TenantId. 检查project_id。 401 VPC.0008 请求中TOKEN无效或者不带TOKEN Invalid token in the header./Authorization information is wrong. 检查TOKEN是否合法。 400 VPC.1801 value长度非法。 Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] 检查使用合法的value值。 400 VPC.1801 key或者value中含有非法字符。 InvalidInput/Tag value xxx is invalid. 检查key或者value的合法性。 400 VPC.1801 Key或者value为空。 Tag xxx can not be null. 检查key或者value是否非空。 400 VPC.1801 Tag为空。 Tag can not be null. 检查tag是否为空。 400 VPC.1801 resource_type错误。 Resource xxx is invalid. 合法的resource_type为loadbalancers或listeners。 400 VPC.1801 一次性传入的tag总数超过10个。 number of tags exceeds max unm of 10. 减少传入tag的个数。 400 VPC.1814 资源已有的tag个数加上传入的tag个数总和超过10个。 Invalid input for operation: resource_id: XXXX, number of tags exceed max num of 10. 减少传入tag的个数。 400 VPC.1814 传入的多个tag中，key值有重复。 Invalid input for operation: tags key is duplicated. 修改tag值。 400 VPC.1814 Resource id不存在。 Resource XXX XXX could not be found. 检查资源是否存在。 400 VPC.1814 指定key删除时输入不存在的key或者key为空字符串。 The resource could not be found. 输入正确的key后重新下发请求。 400 VPC.1814 给指定资源添加tag时超过10个。 Invalid input for operation:resource_id:xxx, number of tags exceeds max num of 10。 一个资源最多支持10个tag。 400 VPC.1801 创建时Tag重复 Tag key is repeated。 去掉重复tag后重新下发请求。 500 - 请求体格式错误。 Internal Server Error. 检查使用正确请求体格式。 父主题： 标签管理

响应示例 状态码： 201 POST操作正常返回。 { "request_id" : "b60d1d9a-5263-45b0-b1d6-2810ac7c52a1", "l7policy" : { "redirect_pool_id" : "768e9e8c-e7cb-4fef-b24b-af9399dbb240", "description" : "", "admin_state_up" : true, "rules" : [ { "id" : "c5c2d625-676b-431e-a4c7-c59cc2664881" } ], "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "listener_id" : "cdb03a19-16b7-4e6b-bfec-047aeec74f56", "redirect_url" : null, "redirect_url_config" : null, "fixed_response_config" : null, "redirect_listener_id" : null, "action" : "REDIRECT_TO_POOL", "position" : 100, "priority" : null, "provisioning_status" : "ACTIVE", "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307", "name" : "l7policy-67" } }

请求示例 创建监听器重定向转发策略 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies { "l7policy" : { "action" : "REDIRECT_TO_LISTENER", "listener_id" : "e2220d2a-3faf-44f3-8cd6-0c42952bd0ab", "redirect_listener_id" : "48a97732-449e-4aab-b561-828d29e45050" } }

操作步骤 发送“GET /v3/{project_id}/elb/members”，project_id为项目ID，其他查询条件根据实际使用情况添加，具体可以参考API文档。在Request Header中增加“X-Auth-Token”。 查看请求响应结果，从响应字段中的instance_id获取ECS ID。 请求成功时，响应参数如下： { "request_id": "0df89f0ad2ecf0e0a5688978d28e9a6d", "members": [ { "weight": 1, "admin_state_up": true, "project_id": "04dd36f9c0000fe22f9fc00b409f1sq1", "address": "192.168.2.96", "protocol_port": 80, "id": "0b7c1e58-5940-41c1-a7c5-dbe4b3f23e4w", "operating_status": ONLINE, "status": [ { "listener_id": "73bea9d6-fb7f-47cc-b949-c3382abb1f46", "operating_status": "ONLINE" } ], "instance_id": "6985a0dc-5884-40f2-9426-15fb4bab8f1d", // ECS ID "device_id": "6985a0dc-5884-40f2-9426-15fb4bab8f1d", "device_owner": "compute:az1", "member_type": "instance", "created_at": "2023-05-15T07:15:43Z", "updated_at": "2023-05-15T07:15:53Z", "loadbalancer_id": "955af176-4275-49ac-b47e-05912x9dj33c", "loadbalancers": [ { "id": "955af176-4275-49ac-b47e-05912x9dj33c" } ], "pool_id": "b6e6fdcf-4f4d-4d21-95ca-925143af6de8", "ip_version": "v4", "subnet_cidr_id": "b765590e-905e-4e13-9d34-0e0ea9de2k9d" } ], "page_info": { "previous_marker": "0b7c1e58-5940-41c1-a7c5-dbe4b3f83506", "current_count": 1 } } 请求异常时，错误码请参见 错误码。

响应示例 响应样例 { "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ] }

响应参数 表3 响应参数 参数 参数类型 描述 tags Array 标签列表，按key值聚合。详见表4。 例如：一个用户共有2个监听器，监听器A标签的键为"test",值为“value1”；监听器B标签的键为"test",值为“value2”。则查询到的标签列表中对象的key为“test”，values为["value1","value2"] 表4 tags 字段数据结构说明 参数 参数类型 描述 key String 键。 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 values Array 标签值列表。 长度不超过43个字符。 由英文字母、数字、下划线、点、中划线、中文字符组成。

请求示例 根据ID批量删除后端服务器。 POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-delete { "members" : [ { "id" : "141a8dea-b3f9-4fed-a1e2-30678f53de0b" }, { "id" : "14d0a82b-fcc2-4ce8-aac8-96d86a7973e4" } ] } 根据IP和port批量删除后端服务器 POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-delete { "members" : [ { "address" : "192.168.0.48", "protocol_port" : 8080 }, { "address" : "192.168.0.49", "protocol_port" : 8080 } ] }

响应示例 状态码： 201 操作正常返回。 { "request_id" : "db97a1d3c5ee386729dc00e4df1d5708", "members" : [ { "id" : "141a8dea-b3f9-4fed-a1e2-30678f53de0b", "ret_status" : "not found" }, { "id" : "14d0a82b-fcc2-4ce8-aac8-96d86a7973e4", "ret_status" : "successful" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of BatchDeleteMembersOption objects 批量删除后端服务器请求body。 表4 BatchDeleteMembersOption 参数 是否必选 参数类型 描述 id 否 String 需要删除的后端服务器ID。 使用说明： 若传入id则不能传其他参数，否则报错。 说明： 说明： 此处并非ECS服务器的ID，而是ELB为绑定的后端服务器自动生成的member ID。 address 否 String 后端服务器IP地址。 使用说明： address和protocol_port必须同时传入。 不能同时传入ID字段 protocol_port 否 Integer 后端服务器端口。 使用说明： address和protocol_port必须同时传入。 不能同时传入ID字段 可以传0，用于删除端口透传pool下的member

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 members Array of BatchDeleteMembersState objects 后端服务器对象列表。 表6 BatchDeleteMembersState 参数 参数类型 描述 id String 后端服务器ID。 说明： 说明： 此处并非ECS服务器的ID，而是ELB为绑定的后端服务器自动生成的member ID。 ret_status String 当前后端服务器删除结果状态。 取值： successful：删除成功。 not found：member不存在。

SSL证书管理 权限 对应API接口 授权项（Action） IAM项目（Project） 企业项目（Enterprise Project） 创建证书 POST /v2/{project_id}/elb/certificates elb:certificates:create √ √ 查询证书 GET /v2/{project_id}/elb/certificates/{certificate_id} elb:certificates:get √ √ 查询证书列表 GET /v2/{project_id}/elb/certificates elb:certificates:list √ √ 更新证书 PUT /v2/{project_id}/elb/certificates/{certificate_id} elb:certificates:put √ √ 删除证书 DELETE /v2/{project_id}/elb/certificates/{certificate_id} elb:certificates:delete √ √ 父主题： V2API授权项列表

响应示例 状态码： 200 操作正常返回。 { "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "My pool", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor_id" : "", "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" }, { "id" : "61942790-2367-482a-8b0e-93840ea2a1c6" }, { "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be" } ], "members" : [ ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool.", "ip_version" : "dualstack" }, "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 pool Pool object 后端服务器组对象。 表4 Pool 参数 参数类型 描述 admin_state_up Boolean 后端云服务器组的管理状态，只支持设置为true。 不支持该字段，请勿使用。 description String 后端云服务器组的描述信息。 healthmonitor_id String 后端云服务器组关联的健康检查的ID。 id String 后端云服务器组的ID。 lb_algorithm String 后端云服务器组的负载均衡算法。 取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。 使用说明： 当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 只有pool的protocol为QUIC时，才支持QUIC_CID算法。 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、HTTP、HTTPS、QUIC和TCPSSL。 使用说明： listener的protocol为UDP时，pool的protocol必须为UDP或QUIC； listener的protocol为TCP时pool的protocol必须为TCP； listener的protocol为HTTP时，pool的protocol必须为HTTP。 listener的protocol为HTTPS时，pool的protocol必须为HTTP或HTTPS。 listener的protocol为TERMINATED_HTTPS时，pool的protocol必须为HTTP。 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。 session_persistence SessionPersistence object 会话持久性对象。 ip_version String 后端云服务器组支持的IP版本。 取值： 共享型：固定为v4； 独享型：取值dualstack、v4、v6。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。 当协议为HTTP时，ip_version为v4。 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 后端服务器组的类型。 取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。 空字符串（""）：允许任意类型的后端 protection_status String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 any_port_enable Boolean 后端是否开启端口透传，开启后，后端服务器端口与前端监听器端口保持一致。取值：false不开启，true开启，默认false。 说明： 关闭端口透传后，请求会转发给后端服务器protocol_port字段指定端口。 表5 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表6 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表7 MemberRef 参数 参数类型 描述 id String 后端服务器ID。 表8 SessionPersistence 参数 参数类型 描述 cookie_name String cookie名称。 共享型LB，支持字母、数字、中划线(-)和下划线()，最大长度64个字符。 独享型LB，支持字母、数字、中划线(-)、下划线()和点号(.)，最大长度255个字符。 使用说明： 只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。 type String 会话保持类型。 取值范围：SOURCE_IP、HTTP_COOKIE、APP_COOKIE。 使用说明： 当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效。 当pool的protocol为HTTP、HTTPS时。如果是独享型负载均衡器的pool， 则type只能为HTTP_COOKIE，其他取值会话保持失效。 如果是共享型负载均衡器的pool，则type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。 persistence_timeout Integer 会话保持的时间。当type为APP_COOKIE时不生效。 适用范围：如果pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1； 如果pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。 表9 SlowStart 参数 参数类型 描述 enable Boolean 慢启动的开关，默认值：false； true：开启； false：关闭 缺省值：false duration Integer 慢启动的持续时间。取值：30~1200s，默认30s； 最小值：30 最大值：1200 缺省值：30

后端云服务器组 权限 对应API接口 授权项（Action） IAM项目（Project） 企业项目（Enterprise Project） 创建pool POST /v2/{project_id}/elb/pools elb:pools:create √ √ 查询pool GET /v2/{project_id}/elb/pools/{pool_id} elb:pools:get √ √ 查询pool列表 GET /v2/{project_id}/elb/pools elb:pools:list √ √ 更新pool PUT /v2/{project_id}/elb/pools/{pool_id} elb:pools:put √ √ 删除pool DELETE /v2/{project_id}/elb/pools/{pool_id} elb:pools:delete √ √ 父主题： V2API授权项列表

响应示例 响应样例1 { "listeners": [ { "client_ca_tls_container_ref": null, "protocol": "TCP", "description": "", "default_tls_container_ref": null, "admin_state_up": true, "http2_enable": false, "loadbalancers": [ { "id": "bc7ba445-035a-4464-a1a3-a62cf4a14116" } ], "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "sni_container_refs": [], "connection_limit": -1, "protocol_port": 80, "default_pool_id": "ed75f16e-fcc6-403e-a3fb-4eae82005eab", "id": "75045172-70e9-480d-9443-b8b6459948f7", "tags": [], "name": "listener-cb2n", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14", "insert_headers":{ "X-Forwarded-ELB-IP":true, } }, { "client_ca_tls_container_ref": null, "protocol": "TCP", "description": "", "default_tls_container_ref": null, "admin_state_up": true, "http2_enable": false, "loadbalancers": [ { "id": "165b6a38-5278-4569-b747-b2ee65ea84a4" } ], "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "sni_container_refs": [], "connection_limit": -1, "protocol_port": 8080, "default_pool_id": null, "id": "dada0003-7b0e-4de8-a4e1-1e937be2ba14", "tags": [], "name": "lsnr_name_mod", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14", "insert_headers":{ "X-Forwarded-ELB-IP":true, } } ], "listeners_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/listeners?limit=2&marker=042cc6a5-e385-4e39-83de-4dde1f801ccb", "rel": "next" }, { "href": "https://{Endpoint}/v2.0/lbaas/listeners?limit=2&marker=025fcaa9-0159-4a0d-8583-d97fa77d9972&page_reverse=True", "rel": "previous" } ] }

响应消息 表3 响应参数 参数 参数类型 描述 listeners Array 监听器对象列表。详见表4。 listeners_links Array 监听器的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。详见表 listeners_links字段说明。 表4 listeners字段说明 参数 参数类型 描述 id String 监听器ID。 tenant_id String 监听器所在的项目ID。 支持的最大字符长度：255 project_id String 此参数和tenant_id参数含义一样，均指监听器所在的项目ID。 name String 监听器名称。 支持的最大字符长度：255 description String 监听器描述信息。 支持的最大字符长度：255 protocol String 监听器的监听协议。 取值范围：TCP、HTTP、UDP、TERMINATED_HTTPS。 protocol_port Integer 监听器的监听端口。 取值范围：[1, 65535]。 loadbalancers Array 监听器绑定的负载均衡器ID的列表。 connection_limit Integer 监听器的最大连接数。 取值范围：[-1, 2147483647]。 说明： 该字段为预留字段，暂未启用。默认为-1，无连接数限制。 admin_state_up Boolean 监听器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 http2_enable Boolean HTTP2功能的开启状态。 取值范围：true/false。true：开启。false：关闭。 说明： 仅针对监听器的协议为TERMINATED_HTTPS有意义。 keepalive_timeout Integer 空闲超时时间。 仅适用于监听器的协议为TCP、HTTP、TERMINATED_HTTPS。 取值范围： TCP： [10, 4000]，单位：秒，默认值：300。 HTTP/TERMINATED_HTTPS：[0, 4000]，单位：秒，默认值：60。 client_timeout Integer 请求超时时间。 取值范围： [1, 300]。单位：秒。默认值：60。 该字段仅在protocol为HTTP或HTTPS下有效；其他情况下，请求体中不应有该字段，否则报错。protocol为HTTP或HTTPS的情况下，若请求体中，无该字段或该字段值为null时，则该字段被赋为默认值。 member_timeout Integer 响应超时时间。 取值范围： [1, 300]。单位：秒。默认值：60。 该字段仅在protocol为HTTP或HTTPS下有效；其他情况下，请求体中不应有该字段，否则报错。protocol为HTTP或HTTPS的情况下，若请求体中，无该字段或该字段值为null时，则该字段被赋为默认值。 default_pool_id String 监听器的默认后端云服务器组ID。 说明： 当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。当该字段为null时，表示监听器无默认的后端云服务器组。 default_tls_container_ref String 监听器使用的服务器证书ID。详细参见SSL证书管理。 当protocol参数为TERMINATED_HTTPS时，为必选字段。 支持的最大字符长度：128 client_ca_tls_container_ref String 监听器使用的CA证书ID。详细参见SSL证书管理。 支持的最大字符长度：128 sni_container_refs Array 监听器使用的SNI证书（带域名的服务器证书）ID的列表。 tags Array 监听器的标签。 created_at String 监听器的创建时间。YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 updated_at String 监听器的更新时间。YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 listeners_links Array 监听器的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。详见表8。 insert_headers Object HTTP扩展头部，内部字段全量同步，不选则为默认值。 可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器上。 例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。详细参见表6。 仅当监听器的协议为HTTP、TERMINATED_HTTPS时，该字段有意义。 tls_ciphers_policy String 监听器使用的安全策略，仅对TERMINATED_HTTPS协议类型的监听器有效，且默认值为tls-1-0。 取值包括：tls-1-0-inherit，tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表7。 表5 loadbalancers字段说明 参数 参数类型 描述 id String 关联的负载均衡器id 表6 insert_headers字段说明 参数 参数类型 描述 X-Forwarded-ELB-IP Boolean 负载均衡器弹性公网IP透传开关。打开时可以将负载均衡器的弹性公网IP从报文的HTTP头中带到后端云服务器。 取值范围：true/false。true：开启。false：关闭。 默认：关闭。 X-Forwarded-Host Boolean 负载均衡器X-Forwarded-Host重写开关。打开时可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器 取值范围：true/false。true：开启。false：关闭。 默认：开启。 表7 tls_ciphers_policy取值说明 安全策略 支持的TLS版本类型 使用的加密套件列表 tls-1-0-inherit TLS 1.2 TLS 1.1 TLS 1.0 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA tls-1-0 TLS 1.2 TLS 1.1 TLS 1.0 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA tls-1-1 TLS 1.2 TLS 1.1 tls-1-2 TLS 1.2 tls-1-2-strict TLS 1.2 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384 表8 listeners_links字段说明 参数 参数类型 描述 href String 监听器的分页查询中上下页的url。 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。 获取方法详见获取项目ID。 project_id 否 String 此参数和tenant_id参数含义一样，均指监听器所在的项目ID。 获取方法详见获取项目ID。 name 否 String 监听器名称。 支持的最大字符长度：255 description 否 String 监听器的描述信息。 支持的最大字符长度：255 loadbalancer_id 否 String 监听器所在的负载均衡器ID。 connection_limit 否 Integer 监听器的最大连接数。 admin_state_up 否 Boolean 监听器的管理状态。 该字段为预留字段，暂未启用。默认为true。 default_pool_id 否 String 监听器的默认后端云服务器组ID。 http2_enable 否 Boolean HTTP2功能的开启状态。 取值范围：true/false。true：开启。false：关闭。 default_tls_container_ref 否 String 监听器使用的服务器证书ID。 支持的最大字符长度：128 client_ca_tls_container_ref 否 String 监听器使用的CA证书ID。 支持的最大字符长度：128 protocol 否 String 监听器的监听协议。 取值范围：TCP、HTTP、UDP、TERMINATED_HTTPS。 protocol_port 否 Integer 监听器的监听端口。 tls_ciphers_policy 否 String 监听器使用的安全策略，仅对TERMINATED_HTTPS协议类型的监听器有效。 取值包括：tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表2。 tls_container_id 否 String 查询证书所关联的监听器。 sni_container_refs 否 String 查询SNI证书关联的监听器。 表2 tls_ciphers_policy取值说明 安全策略 支持的TLS版本类型 使用的加密套件列表 tls-1-0-inherit TLS 1.2 TLS 1.1 TLS 1.0 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA tls-1-0 TLS 1.2 TLS 1.1 TLS 1.0 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA tls-1-1 TLS 1.2 TLS 1.1 tls-1-2 TLS 1.2 tls-1-2-strict TLS 1.2 ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

响应示例 状态码： 200 操作正常返回。 { "request_id" : "010dad1e-32a3-4405-ab83-62a1fc5f8722", "loadbalancer" : { "id" : "2e073bf8-edfe-4e51-a699-d915b0b8af89", "project_id" : "b2782e6708b8475c993e6064bc456bf8", "name" : "loadbalancer-update", "description" : "loadbalancer", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ { "id" : "41937176-bf64-4b58-8e0d-9ff2d0d32c54" }, { "id" : "abc6ac93-ad0e-4765-bd5a-eec632efde56" }, { "id" : "b9d8ba97-6d60-467d-838d-f3550b54c22a" }, { "id" : "fd797ebd-263d-4b18-96e9-e9188d36c69e" } ], "pools" : [ { "id" : "0aabcaa8-c35c-4ddc-a60c-9032d0ac0b80" }, { "id" : "165d9092-396e-4a8d-b398-067496a447d2" } ], "tags" : [ ], "provider" : "vlb", "created_at" : "2019-04-20T03:10:37Z", "updated_at" : "2019-05-24T02:11:58Z", "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417", "enterprise_project_id" : "0", "availability_zone_list" : [ "AZ1", "AZ2", "dc3" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : null, "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null, "deletion_protection_enable" : false, "public_border_group" : "center" } }

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 loadbalancer LoadBalancer object 负载均衡器对象。（包周期规格变更场景不返回该字段） loadbalancer_id String 负载均衡器的id 最小长度：0 最大长度：36 order_id String 订单号 最小长度：0 最大长度：36 request_id String 请求ID。 注：自动生成 。 最小长度：0 最大长度：36 表9 LoadBalancer 参数 参数类型 描述 id String 负载均衡器ID。 description String 负载均衡器描述信息。 最小长度：1 最大长度：255 provisioning_status String 负载均衡器的配置状态。 取值： ACTIVE：使用中。 PENDING_DELETE：删除中。 admin_state_up Boolean 负载均衡器的管理状态。取值：false停用，true启用。 provider String 负载均衡器的生产者名称。固定为vlb。 pools Array of PoolRef objects 负载均衡器直接关联的后端云服务器组的ID列表。 listeners Array of ListenerRef objects 负载均衡器关联的监听器的ID列表。 operating_status String 负载均衡器的操作状态。 取值： ONLINE：在线。 name String 负载均衡器的名称。 project_id String 负载均衡器所属的项目ID。 vip_subnet_cidr_id String 负载均衡器所在子网的IPv4子网ID。 vip_address String 负载均衡器的IPv4虚拟IP地址。 vip_port_id String 负载均衡器的IPv4对应的port ID。 tags Array of Tag objects 负载均衡的标签列表。 created_at String 负载均衡器的创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' updated_at String 负载均衡器的更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' guaranteed Boolean 是否独享型LB。 取值： false：共享型。 true：独享型。 vpc_id String 负载均衡器所在VPC ID。 eips Array of EipInfo objects 负载均衡器绑定的EIP。只支持绑定一个EIP。 注：该字段与publicips一致。 ipv6_vip_address String 双栈类型负载均衡器的IPv6地址。 ipv6_vip_virsubnet_id String 双栈类型负载均衡器所在子网的IPv6网络ID。 ipv6_vip_port_id String 双栈类型负载均衡器的IPv6对应的port ID。 availability_zone_list Array of strings 负载均衡器所在的可用区列表。 enterprise_project_id String 企业项目ID。创建时不传则返回"0"，表示资源属于default企业项目。 注："0"并不是真实存在的企业项目ID，在创建、更新和查询时不能作为请求参数传入。 billing_info String 资源账单信息。 取值： 空：按需计费。 最小长度：1 最大长度：1024 l4_flavor_id String 四层Flavor ID。 对于弹性扩缩容实例，表示上限规格。 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费； 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费 最小长度：1 最大长度：255 l4_scale_flavor_id String 四层弹性Flavor ID。 不支持该字段，请勿使用。 最小长度：1 最大长度：255 l7_flavor_id String 七层Flavor ID。 对于弹性扩缩容实例，表示上限规格ID。 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费； 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费 最小长度：1 最大长度：255 l7_scale_flavor_id String 七层弹性Flavor ID。 不支持该字段，请勿使用。 最小长度：1 最大长度：255 publicips Array of PublicIpInfo objects 负载均衡器绑定的公网IP。只支持绑定一个公网IP。 注：该字段与eips一致。 global_eips Array of GlobalEipInfo objects 负载均衡器绑定的global eip。只支持绑定一个globaleip。 elb_virsubnet_ids Array of strings 下联面子网的网络ID列表。 elb_virsubnet_type String 下联面子网类型 ipv4：ipv4 dualstack：双栈 ip_target_enable Boolean 是否启用跨VPC后端转发。 开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。 仅独享型负载均衡器支持该特性。 取值： true：开启。 false：不开启。 使用说明： 开启不能关闭。 frozen_scene String 负载均衡器的冻结场景。 若负载均衡器有多个冻结场景，用逗号分隔。 取值： POLICE：公安冻结场景。 ILLEGAL：违规冻结场景。 VERIFY：客户未实名认证冻结场景。 PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。 AREAR：欠费冻结场景。 ipv6_bandwidth BandwidthRef object 带宽对象ID，仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。 deletion_protection_enable Boolean 是否开启删除保护。 取值： false：不开启。 true：开启。 说明： 退场时需要先关闭所有资源的删除保护开关。 仅当前局点启用删除保护特性后才会返回该字段。 autoscaling AutoscalingRef object 弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。 使用说明： 仅当租户白名单放开后该字段才有效 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 public_border_group String LB所属AZ组 charge_mode String 收费模式。取值： flavor：按规格计费 lcu：按使用量计费 waf_failure_action String WAF故障时的流量处理策略。discard:丢弃，forward: 转发到后端（默认） 使用说明：只有绑定了waf的LB实例，该字段才会生效。 protection_status String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 log_group_id String LB所绑定的logtank对应的group id log_topic_id String LB所绑定的logtank对应的topic id 表10 PoolRef 参数 参数类型 描述 id String 后端服务器组ID。 表11 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表12 Tag 参数 参数类型 描述 key String 标签键 最小长度：1 最大长度：36 value String 标签值 最小长度：0 最大长度：43 表13 EipInfo 参数 参数类型 描述 eip_id String eip_id eip_address String eip_address ip_version Integer IP版本号。 取值：4表示IPv4,6表示IPv6。 表14 PublicIpInfo 参数 参数类型 描述 publicip_id String 弹性公网ip配置id publicip_address String IP地址 ip_version Integer IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6 表15 GlobalEipInfo 参数 参数类型 描述 global_eip_id String global eip的id global_eip_address String global eip的ip地址 ip_version Integer IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6 表16 BandwidthRef 参数 参数类型 描述 id String 共享带宽的id 表17 AutoscalingRef 参数 参数类型 描述 enable Boolean 当前负载均衡器是否开启弹性扩缩容。 取值： true：开启。 false：不开启，默认值。 min_l7_flavor_id String 弹性扩缩容的最小七层规格ID（规格类型L7_elastic），有七层监听器时，该字段不能为空。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 最小长度：1 最大长度：36

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 最小长度：0 最大长度：4096 表3 请求Body参数 参数 是否必选 参数类型 描述 loadbalancer 是 UpdateLoadBalancerOption object 负载均衡器对象。 表4 UpdateLoadBalancerOption 参数 是否必选 参数类型 描述 name 否 String 负载均衡器的名称。 最小长度：0 最大长度：255 admin_state_up 否 Boolean 负载均衡器的管理状态。只能设置为true。 description 否 String 负载均衡器的描述。 最小长度：0 最大长度：255 ipv6_vip_virsubnet_id 否 String 双栈类型负载均衡器所在子网的IPv6网络ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。 通过更新ipv6_vip_virsubnet_id可以更新负载均衡器所在IPv6子网，且负载均衡器的内网IPv6地址将发生变化。 使用说明： ipv6_vip_virsubnet_id 对应的子网必须属于当前负载均衡器所在VPC，且子网需开启支持IPv6。 只有guaranteed是true的负载均衡器才支持更新ipv6_vip_virsubnet_id。 传入为null表示解绑IPv6子网。 更新IPv6子网不会导致IPv4子网发生变化。 vip_subnet_cidr_id 否 String 负载均衡器所在的IPv4子网ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到。 通过更新vip_subnet_cidr_id可以更新负载均衡器所在IPv4子网，并且负载均衡器的内网IPv4地址将发生变化。 使用说明： 若同时设置了vip_address，则必须保证vip_address对应的IP在vip_subnet_cidr_id的子网网段中。 vip_subnet_cidr_id对应的子网必须属于当前负载均衡器vpc_id对应的VPC。 只有guaranteed是true的负载均衡器才支持更新vip_subnet_cidr_id。 传入null表示解绑IPv4子网。 更新IPv子网不会导致IPv4子网发生变化。 最小长度：1 最大长度：36 vip_address 否 String 负载均衡器的IPv4虚拟IP。该地址必须包含在所在子网的IPv4网段内，且未被占用。 注：仅当guaranteed是true的场合，才支持更新。 最小长度：1 最大长度：36 l4_flavor_id 否 String 四层Flavor ID。 使用说明： 仅当guaranteed是true的场合，才支持更新。 不允许非null变成null，null变成非null，即不配置七层规格和配置七层规格之间不允许切换； 可以支持规格改大改小，注意改小过程中可能会造成部分长连接中断，影响部分链接的新建， autoscaling.enable=true时，修改无意义，不生效。 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费。 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费。 最小长度：1 最大长度：255 l7_flavor_id 否 String 七层Flavor ID。 使用说明： 仅当guaranteed是true的场合，才支持更新。 不允许非null变成null，null变成非null，即不配置七层规格和配置七层规格之间不允许切换； 可以支持规格改大改小，注意改小过程中可能会造成部分长连接中断，影响部分链接的新建， autoscaling.enable=true时，修改无意义，不生效。 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费。 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费。 最小长度：1 最大长度：36 ipv6_bandwidth 否 BandwidthRef object 带宽对象ID，仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。 ip_target_enable 否 Boolean 是否启用跨VPC后端转发。 开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。 仅独享型负载均衡器支持该特性。 取值： true：开启。 false：不开启。 使用说明： 开启不能关闭。 elb_virsubnet_ids 否 Array of strings 下联面子网的网络ID列表。 可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。 已绑定的下联面子网也在传参elb_virsubnet_ids列表中，则绑定关系保留。 已绑定的下联面子网若不在传参elb_virsubnet_ids列表中， 则将移除LB与该下联面子网的关联关系。但不允许移除已被ELB使用的子网，否则将报错，不做任何修改。 在传参elb_virsubnet_ids列表中但不在已绑定的下联面子网列表中，则将新增LB与下联面的绑定关系。 使用说明： 所有ID同属于该LB所在的VPC。 不支持边缘云子网。 最小长度：1 最大长度：64 数组长度：0 - 64 deletion_protection_enable 否 Boolean 是否开启删除保护。 取值：false不开启，true开启。 说明： 退场时需要先关闭所有资源的删除保护开关。 prepaid_options 否 PrepaidUpdateOption object 负载均衡器的包周期规格变更信息 autoscaling 否 UpdateLoadbalancerAutoscalingOption object 弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。 使用说明： 仅当租户白名单放开后该字段才有效 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 charge_mode 否 String 计费模式。 取值： flavor：按规格计费 waf_failure_action 否 String WAF故障时的流量处理策略。discard:丢弃，forward: 转发到后端（默认） 使用说明：只有绑定了waf的LB实例，该字段才会生效。 最小长度：0 最大长度：36 protection_status 否 String 修改保护状态, 取值： nonProtection: 不保护 consoleProtection: 控制台修改保护 protection_reason 否 String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 ipv6_vip_address 否 String 双栈类型负载均衡器的IPv6地址。 表5 BandwidthRef 参数 是否必选 参数类型 描述 id 是 String 共享带宽的id 表6 PrepaidUpdateOption 参数 是否必选 参数类型 描述 auto_pay 否 Boolean 下单订购后，是否自动从客户的账户中支付； true：自动支付； false：不自动支付（默认）。 自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 缺省值：false change_mode 否 String 规格变更类型： immediate：即时变更，规格变更立即生效。（默认） delay：续费变更，当前周期结束后变更为目标规格。 缺省值：immediate 最小长度：0 最大长度：10 period_num 否 Integer 订购周期数（默认1），取值会随运营策略变化。（仅在change_mode为delay时生效） period_type为month时，为[1,9]， period_type为year时，为[1,3] 最小值：1 最大值：9 缺省值：1 period_type 否 String 订购周期类型，当前支持包月和包年： （仅在change_mode为delay时生效） month：月（默认）； year：年； 缺省值：month 表7 UpdateLoadbalancerAutoscalingOption 参数 是否必选 参数类型 描述 enable 是 Boolean 当前负载均衡器是否开启弹性扩缩容。 取值： true：开启。 false：不开启。 缺省值：false min_l7_flavor_id 否 String 弹性扩缩容的最小七层规格ID（规格类型L7_elastic），有七层监听器时，该字段不能为空。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 最小长度：1 最大长度：36

请求消息 表1 请求参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID，表示上一页最后一条查询记录的白名单的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的白名单个数。如果不设置，则默认不分页查询所有。 page_reverse 否 Boolean 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 id 否 String 白名单ID。 tenant_id 否 String 白名单所在的项目ID。 支持的最大字符长度：255 listener_id 否 String 白名单关联的监听器ID。 enable_whitelist 否 Boolean 是否开启访问控制开关。 true：打开 false：关闭 whitelist 否 String 白名单IP的字符串。

请求示例 请求样例1 全量查询白名单 GET https://{Endpoint}/v2.0/lbaas/whitelists 请求样例2 过滤查询监听器eabfefa3fd1740a88a47ad98e132d230关联的白名单 GET https://{Endpoint}/v2.0/lbaas/whitelists?listener_id=eabfefa3fd1740a88a47ad98e132d230

响应消息 表2 响应参数 参数 参数类型 描述 whitelists Array 白名单对象列表。详见表3。 whitelists_links Array 白名单的分页查询中上下页的链接信息。 仅当分页查询时响应体中有该字段。 详见表4。 表3 whitelist字段说明 参数 参数类型 描述 id String 白名单的ID。 tenant_id String 白名单所在的项目ID。 支持的最大字符长度：255 listener_id String 白名单关联的监听器ID。 enable_whitelist Bool 是否开启访问控制开关。 true：打开 false：关闭 whitelist String 白名单IP的字符串。 表4 whitelists_links字段说明 参数 参数类型 描述 href String 白名单的分页查询中上下页的链接。 rel String 上下页的提示信息。 取值范围：next、previous。next表示href是下一页的url，previous表示href是上一页的url。

响应示例 响应样例1 { "whitelists": [ { "id": "eabfefa3fd1740a88a47ad98e132d238", "listener_id": "eabfefa3fd1740a88a47ad98e132d238", "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", "enable_whitelist": true, "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" }, { "id": "eabfefa3fd1740a88a47ad98e132d326", "listener_id": "eabfefa3fd1740a88a47ad98e132d327", "tenant_id": "eabfefa3fd1740a88a47ad98e132d436", "enable_whitelist": true, "whitelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" } ] } 响应样例2 { "whitelists": [ { "id": "eabfefa3fd1740a88a47ad98e132d238", "listener_id": "eabfefa3fd1740a88a47ad98e132d230", "tenant_id": "eabfefa3fd1740a88a47ad98e132d239", "enable_whitelist": true, "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" }, { "id": "eabfefa3fd1740a88a47ad98e132d326", "listener_id": "eabfefa3fd1740a88a47ad98e132d327", "tenant_id": "eabfefa3fd1740a88a47ad98e132d439", "enable_whitelist": true, "whitelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" } ] }

响应示例 状态码： 200 操作正常返回。 { "flavor" : { "shared" : true, "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee", "info" : { "bandwidth" : 10000000, "connection" : 8000000, "cps" : 80000, "qps" : 160000, "lcu" : 100 }, "id" : "3588b525-63ed-4b8f-8a03-6aaa9ad1c36a", "name" : "L7_flavor.slb.s2.large", "type" : "L7", "flavor_sold_out" : false }, "request_id" : "3b9fb516-b7bb-4760-9128-4a23dd36ae10" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 flavor Flavor object 规格对象。 表4 Flavor 参数 参数类型 描述 id String 规格ID。 info FlavorInfo object 规格相关的指标。 name String 规格名称。 规格名称与控制台展示的对应关系如下： 网络型有如下规格： L4_flavor.elb.s1.small: 小型 I L4_flavor.elb.s2.small: 小型 II L4_flavor.elb.s1.medium: 中型 I L4_flavor.elb.s2.medium: 中型 II L4_flavor.elb.s1.large: 大型 I L4_flavor.elb.s2.large: 大型 II 应用型有如下规格： L7_flavor.elb.s1.small: 小型 I L7_flavor.elb.s2.small: 小型 II L7_flavor.elb.s1.medium: 中型 I L7_flavor.elb.s2.medium: 中型 II L7_flavor.elb.s1.large: 大型 I L7_flavor.elb.s2.large: 大型 II L7_flavor.elb.s1.extra-large: 超大型 I L7_flavor.elb.s2.extra-large: 超大型 II shared Boolean 是否公共规格。 取值： true表示公共规格，所有租户可见。 false表示私有规格，为当前租户所有。 project_id String 项目ID。 type String 规格类别。 取值： L4和L7 表示四层和七层flavor。 L4_elastic和L7_elastic 表示弹性扩缩容实例的下限规格。 L4_elastic_max和L7_elastic_max 表示弹性扩缩容实例的上限规格。 最小长度：1 最大长度：32 flavor_sold_out Boolean 是否售罄。 取值： true：已售罄，将无法购买该规格的LB。 false：未售罄，可购买该规格的LB。 表5 FlavorInfo 参数 参数类型 描述 connection Integer 并发数。单位：个 cps Integer 新建数。单位：个 qps Integer 每秒查询数。单位：个。仅7层LB有该指标。 bandwidth Integer 带宽。单位：Kbit/s。 lcu Integer 当前flavor对应的lcu数量。 LCU是用来衡量独享型ELB处理性能综合指标，LCU值越大，性能越好。单位：个 https_cps Integer https新建连接数。单位：个。仅7层LB有该指标。

响应示例 状态码： 200 操作正常返回。 { "request_id" : "a396ad8e282d69d1afec6d437fe93c2d", "quotas" : [ { "quota_key" : "members_per_pool", "used" : 992, "quota_limit" : 1000, "unit" : "count" }, { "quota_key" : "security_policy", "used" : 11, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "ipgroup_max_length", "used" : 3, "quota_limit" : 300, "unit" : "count" }, { "quota_key" : "listener", "used" : 803, "quota_limit" : 1500, "unit" : "count" }, { "quota_key" : "pool", "used" : 1009, "quota_limit" : 5000, "unit" : "count" }, { "quota_key" : "certificate", "used" : 608, "quota_limit" : -1, "unit" : "count" }, { "quota_key" : "loadbalancer", "used" : 752, "quota_limit" : 100000, "unit" : "count" }, { "quota_key" : "ipgroup", "used" : 11, "quota_limit" : 1000, "unit" : "count" }, { "quota_key" : "ipgroup_bindings", "used" : 2, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "member", "used" : 3022, "quota_limit" : 10000, "unit" : "count" }, { "quota_key" : "listeners_per_loadbalancer", "used" : 0, "quota_limit" : 50, "unit" : "count" }, { "quota_key" : "l7policy", "used" : 148, "quota_limit" : 2000, "unit" : "count" }, { "quota_key" : "healthmonitor", "used" : 762, "quota_limit" : -1, "unit" : "count" } ] }