华为云用户手册

请求示例 创建转发规则，并指定规则类型为路径 POST https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules { "rule" : { "compare_type" : "EQUAL_TO", "type" : "PATH", "value" : "/bbb.html" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 rule 是 CreateRuleOption object 转发规则对象。 表4 CreateRuleOption 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 转发规则的管理状态，默认为true。 不支持该字段，请勿使用。 compare_type 是 String 转发匹配方式。 取值： EQUAL_TO 表示精确匹配。 REGEX 表示正则匹配。 STARTS_WITH 表示前缀匹配。 使用说明： type为HOST_NAME时仅支持EQUAL_TO，支持通配符*。 type为PATH时可以为REGEX，STARTS_WITH，EQUAL_TO。 type为METHOD、SOURCE_IP时，仅支持EQUAL_TO。 type为HEADER、QUERY_STRING，仅支持EQUAL_TO，支持通配符*、？。 key 否 String 匹配项的名称，比如转发规则匹配类型是请求头匹配，则key表示请求头参数的名称。 不支持该字段，请勿使用。 最小长度：0 最大长度：255 value 是 String 匹配项的值。比如转发规则匹配类型是域名匹配，则value表示域名的值。仅当conditions空时该字段生效。 当转发规则类别type为HOST_NAME时，字符串只能包含英文字母、数字、-、.或*，必须以字母、数字或*开头。 若域名中包含*，则*只能出现在开头且必须以*.开始。 当*开头时表示通配0~任一个字符。 当转发规则类别type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。 当转发规则类别type为METHOD、SOURCE_IP、HEADER,QUERY_STRING时， 该字段无意义，使用conditions来指定key/value。 最小长度：1 最大长度：128 project_id 否 String 转发规则所在的项目ID。 最小长度：32 最大长度：32 type 是 String 转发规则类别。 取值： HOST_NAME：匹配域名。 PATH：匹配请求路径。 METHOD：匹配请求方法。 HEADER：匹配请求头。 QUERY_STRING：匹配请求查询参数。 SOURCE_IP：匹配请求源IP地址。 使用说明： 一个l7policy下创建的l7rule的HOST_NAME，PATH，METHOD，SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。 invert 否 Boolean 是否反向匹配。 取值：true、false，默认false。 不支持该字段，请勿使用。 conditions 否 Array of CreateRuleCondition objects 转发规则的匹配条件。当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。 若转发规则配置了conditions，字段key、字段value的值无意义。 同一个rule内的conditions列表中所有key必须相同，value不允许重复。 表5 CreateRuleCondition 参数 是否必选 参数类型 描述 key 否 String 匹配项的名称。 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 key的长度限制1-40字符，只允许包含字母、数字和-_。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号， 反斜杠，双引号，'#'，'&'，'|'，‘%’，‘~’，字母区分大小写。 同一个rule内的conditions列表中所有key必须相同。 最小长度：1 最大长度：128 value 是 String 匹配项的值。 当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。 value长度1-128字符，字符串只能包含英文字母、数字、-、.或*， 必须以字母、数字或*开头，*只能出现在开头且必须以*.开始。 当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 value长度限制1-128字符，不支持空格， 双引号，支持以下通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符） 当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。 当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。 value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。 同一个rule内的conditions列表中所有value不允许重复。 最小长度：1 最大长度：128

响应参数 状态码： 201 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 rule L7Rule object 转发规则对象。 表7 L7Rule 参数 参数类型 描述 admin_state_up Boolean 转发规则的管理状，默认为true。 不支持该字段，请勿使用。 compare_type String 转发规则的匹配方式。type为HOST_NAME时可以为EQUAL_TO。type为PATH时可以为REGEX， STARTS_WITH，EQUAL_TO。 key String 匹配内容的键值。type为HOST_NAME和PATH时，该字段不生效。 最小长度：1 最大长度：255 project_id String 转发规则所在的项目ID。 type String 转发规则类别。 取值： HOST_NAME：匹配域名。 PATH：匹配请求路径。 METHOD：匹配请求方法。 HEADER：匹配请求头。 QUERY_STRING：匹配请求查询参数。 SOURCE_IP：匹配请求源IP地址。 使用说明： 一个l7policy下创建的l7rule的HOST_NAME，PATH，METHOD，SOURCE_IP不能重复。 HEADER、QUERY_STRING支持重复的rule配置。 value String 匹配内容的值。仅当conditions空时该字段生效。 当type为HOST_NAME时，字符串只能包含英文字母、数字、-.，必须以字母、数字或开头。 若域名中包含*，则只能出现在开头且必须以.开始。当*开头时表示通配0~任一个字符。 当type为PATH时，当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以/开头。 当type为METHOD、SOURCE_IP、HEADER, QUERY_STRING时，该字段无意义，使用condition_pair来指定key，value。 最小长度：1 最大长度：128 provisioning_status String provisioning状态，可以为ACTIVE、PENDING_CREATE 或者ERROR。 说明：该字段无实际含义，默认为ACTIVE。 invert Boolean 是否反向匹配。 使用说明：固定为false。该字段能更新但不会生效。 id String 规则ID。 conditions Array of RuleCondition objects 转发规则的匹配条件。当监听器的高级转发策略功能（enhance_l7policy_enable）开启后才会生效。 若转发规则配置了conditions，字段key、字段value的值无意义。 同一个rule内的conditions列表中所有key必须相同，value不允许重复。 created_at String 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 updated_at String 更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 表8 RuleCondition 参数 参数类型 描述 key String 匹配项的名称。 当转发规则类别type为HOST_NAME、PATH、METHOD、SOURCE_IP时，该字段固定为空字符串。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 key的长度限制1-40字符，只允许包含字母、数字和-_。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 key的长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写。 同一个rule内的conditions列表中所有key必须相同。 最小长度：1 最大长度：128 value String 匹配项的值。 当转发规则类别type为HOST_NAME时，key固定为空字符串，value表示域名的值。 value长度1-128字符，字符串只能包含英文字母、数字、-.*， 必须以字母、数字或*开头，*只能出现在开头且必须以*.开始。 当转发规则类别type为PATH时，key固定为空字符串，value表示请求路径的值。 value长度1-128字符。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时， 字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{}，且必须以"/"开头。 当转发规则类别type为HEADER时，key表示请求头参数的名称，value表示请求头参数的值。 value长度限制1-128字符，不支持空格， 双引号，支持以下通配符：*（匹配0个或更多字符）和？（正好匹配1个字符）。 当转发规则类别type为QUERY_STRING时，key表示查询参数的名称，value表示查询参数的值。 value长度限制为1-128字符，不支持空格，中括号，大括号，尖括号，反斜杠，双引号， '#'，'&'，'|'，‘%’，‘~’，字母区分大小写，支持通配符：*（匹配0个或更多字符）和？（正好匹配1个字符） 当转发规则类别type为METHOD时，key固定为空字符串，value表示请求方式。value取值范围为：GET, PUT, POST,DELETE, PATCH, HEAD, OPTIONS。 当转发规则类别type为SOURCE_IP时，key固定为空字符串，value表示请求源地址。 value为CIDR格式，支持ipv4，ipv6。例如192.168.0.2/32，2049::49/64。 同一个rule内的conditions列表中所有value不允许重复。 最小长度：1 最大长度：128

响应消息 表4 响应参数 参数 参数类型 描述 listeners Array of Listeners objects 监听器对象列表。详见表5。 表5 listener字段说明 参数 参数类型 描述 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 of Loadbalancers objects 监听器关联的负载均衡器 ID。详细参见表8。 connection_limit Integer 监听器的最大连接数。 取值范围：[-1, 2147483647]。默认为-1，无连接数限制。 该字段为预留字段，暂未启动。 admin_state_up Boolean 监听器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 http2_enable Boolean HTTP2功能的开启状态。 取值范围：true/false。true：开启。false：关闭。 仅针对监听器的协议为TERMINATED_HTTPS有意义。 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。 支持的最大字符长度：128 详细参见SSL证书管理。 sni_container_refs Array 监听器使用的SNI证书（带域名的服务器证书）ID的列表。 该字段不为空列表时，SNI特性开启。该字段为空列表时，SNI特性关闭。 tags Array 监听器的标签。 created_at String 监听器的创建时间。YYYY-MM-DDTHH:MM:SS updated_at String 监听器的更新时间。YYYY-MM-DDTHH:MM:SS insert_headers InsertHeaders object HTTP扩展头部，内部字段全量同步，不选则为默认值。 可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器上。 例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。详细参见表9。 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多种安全策略。各安全策略使用的加密套件列表。详细参见表10。 表6 loadbalancers字段说明 参数 是否必选 参数类型 描述 id 是 String 关联的负载均衡器id 表7 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：关闭。 默认：开启。 表8 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

响应示例 响应样例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", "insert_headers":{ "X-Forwarded-ELB-IP":true, "X-Forwarded-Host":true }, "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14" }, { "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", "sni_container_refs": [], "connection_limit": -1, "protocol_port": 8080, "default_pool_id": null, "id": "dada0003-7b0e-4de8-a4e1-1e937be2ba14", "tags": [], "name": "lsnr_name_mod", "insert_headers":{ "X-Forwarded-ELB-IP":true, "X-Forwarded-Host":true }, "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14" } ] } 响应样例2 { "listeners": [ { "insert_headers": null, "protocol_port": 64809, "protocol": "UDP", "description": "", "default_tls_container_ref": null, "sni_container_refs": [], "loadbalancers": [ { "id": "c1127125-64a9-4394-a08a-ef3be8f7ef9c" } ], "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "created_at": "2018-11-29T13:56:21", "client_ca_tls_container_ref": null, "connection_limit": -1, "updated_at": "2018-11-29T13:56:22", "http2_enable": false, "insert_headers":{ "X-Forwarded-ELB-IP":true, "X-Forwarded-Host":true }, "admin_state_up": true, "default_pool_id": "2f6895be-019b-4c82-9b53-c4a2ac009e20", "id": "5c63d176-444f-4c75-9cfe-bcb8a05a845c", "tags": [], "name": "listener-tvp8" } ] }

URI GET /v2/{project_id}/elb/listeners 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID，表示上一页最后一条查询记录的监听器的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的监听器个数。如果不设置，则默认不分页查询所有。 page_reverse 否 Boolean 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 id 否 String 监听器 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。 client_ca_tls_container_ref 否 String 监听器使用的CA证书ID。 protocol 否 String 监听器的监听协议。 取值范围：TCP、HTTP、UDP、TERMINATED_HTTPS。 protocol_port 否 Integer 监听器的监听端口。 enterprise_project_id 否 String 企业项目ID，仅用于基于企业项目的细粒度鉴权使用。 如果参数传递default_pool_id，则以pool对应的企业项目ID鉴权。 如果default_pool_id和enterprise_project_id都没有传递 ，则进行细粒度鉴权 ，必须在用户组下分配elb:*list权限才能通过鉴权。 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多种安全策略。各安全策略使用的加密套件列表详细参见表3。 表3 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 OK { "logtank" : { "project_id" : "060576798a80d5762fafc01a9b5eedc7", "log_topic_id" : "5b9b8370-a1fc-4c59-a509-483a673c8a94", "id" : "603e507f-3e18-498b-9460-01a3b6c28fc5", "log_group_id" : "7733882e-f7fa-4fb0-a460-0605c48a2280", "loadbalancer_id" : "47ecc304-3f1a-4cc6-9c1c-72add483b9ce" }, "request_id" : "59662f86620f8fc09c908eed060a2f0e" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 logtank Logtank object 描述信息 表4 Logtank 参数 参数类型 描述 id String 云日志ID。 project_id String 项目ID。 loadbalancer_id String 负载均衡器ID。 log_group_id String 云日志分组ID。 log_topic_id String 云日志主题ID。

配额管理 权限 对应API接口 授权项（Action） IAM项目（Project） 企业项目（Enterprise Project） 查询默认配额 GET /v2/{project_id}/elb/quotas/defaults elb:quotas:list √ x 查询配额 GET /v2/{project_id}/elb/quotas elb:quotas:list √ x 父主题： V2API授权项列表

具体步骤 设置请求消息头。Postman中设置好头部信息，将获取到的Token放入头部，如下图。 图1 设置请求消息头-创建白名单 在Body标签中填写请求消息体。 图2 填写请求消息体-创建白名单 填写URL https://elb.cn-east-2.myhuaweicloud.com/v2.0/lbaas/whitelists 发送请求。 选择请求方法为POST，点击Send按钮，得到服务端响应： { "whitelist": { "tenant_id": "0d0bf0e8fb564cc9abbe526dbdca9248", "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24", "enable_whitelist": true, "id": "317a0ea1-e47b-4e8b-996f-0556270245c3", "listener_id": "a7b996cf-23ec-4c0b-b310-45495d29f80c" } }

示例代码 2中消息体内容 { "whitelist": { "listener_id": "a7b996cf-23ec-4c0b-b310-45495d29f80c", "enable_whitelist": true, "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" } }

响应示例 状态码： 200 操作正常返回。 { "listener" : { "id" : "0b11747a-b139-492f-9692-2df0b1c87193", "name" : "My listener", "protocol_port" : 80, "protocol" : "TCP", "ipgroup" : null, "description" : "My listener update.", "default_tls_container_ref" : null, "admin_state_up" : true, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "member_timeout" : null, "client_timeout" : null, "keepalive_timeout" : 300, "client_ca_tls_container_ref" : null, "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "sni_container_refs" : [ ], "connection_limit" : -1, "default_pool_id" : null, "tls_ciphers_policy" : "tls-1-0", "tags" : [ ], "created_at" : "2019-04-02T00:12:32Z", "updated_at" : "2019-04-02T17:43:46Z", "http2_enable" : true, "insert_headers" : { "X-Forwarded-ELB-IP" : true }, "transparent_client_ip_enable" : false }, "request_id" : "1394eb39-e4c8-4177-b96d-aaff569f1833" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 listener Listener object 监听器对象。 表4 Listener 参数 参数类型 描述 admin_state_up Boolean 监听器的管理状态。只能设置为true。 不支持该字段，请勿使用。 client_ca_tls_container_ref String 监听器使用的CA证书ID。当且仅当type=client时，才会使用该字段对应的证书。 connection_limit Integer 监听器的最大连接数。 取值：-1表示不限制，默认为-1。 不支持该字段，请勿使用。 created_at String 监听器的创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如：2021-07-30T12:03:44Z default_pool_id String 监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。 default_tls_container_ref String 监听器使用的服务器证书ID。 description String 监听器的描述信息。 http2_enable Boolean 客户端与LB之间的HTTPS请求的HTTP2功能的开启状态。 开启后，可提升客户端与LB间的访问性能，但LB与后端服务器间仍采用HTTP1.X协议。 使用说明： 仅HTTPS协议监听器有效。 QUIC监听器不能设置该字段，固定返回为true。 其他协议的监听器可设置该字段但无效，无论取值如何都不影响监听器正常运行。 id String 监听器ID。 insert_headers ListenerInsertHeaders object 可选的HTTP头插入，可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器使。例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。 loadbalancers Array of LoadBalancerRef objects 监听器所属的负载均衡器的ID列表。一个监听器只支持关联到一个LB。 name String 监听器的名称。 注意：若名称为空，则在控制台的监听器列表无法选择并查看监听器详情。 project_id String 监听器所在的项目ID。 protocol String 监听器的监听协议。 取值：TCP、UDP、HTTP、HTTPS、TERMINATED_HTTPS、QUIC、TCPSSL。 使用说明： 共享型LB上的HTTPS监听器只支持设置为TERMINATED_HTTPS， 创建时传入HTTPS将会自动转为TERMINATED_HTTPS。 独享型LB上的HTTPS监听器只支持设置为HTTPS，创建时传入TERMINATED_HTTPS将会自动转为HTTPS。 protocol_port Integer 监听器的监听端口。QUIC监听器端口不能是4789，且不能和UDP监听器端口重复。传0时表示开启监听端口范围的能力，此时port_ranges为必填字段。 最小值：0 最大值：65535 sni_container_refs Array of strings 监听器使用的SNI证书（带域名的服务器证书）ID列表。 使用说明： 列表对应的所有SNI证书的域名不允许存在重复。 列表对应的所有SNI证书的域名总数不超过50。 sni_match_algo String 监听器使用的SNI证书泛域名匹配方式。 longest_suffix表示最长尾缀匹配，wildcard表示标准域名分级匹配。 默认为wildcard。 tags Array of Tag objects 标签列表。 updated_at String 监听器的更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，如：2021-07-30T12:03:44Z tls_ciphers_policy String 监听器使用的安全策略。 取值：tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict，tls-1-2-fs，tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0，默认：tls-1-0。 使用说明： 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 QUIC监听器不支持该字段。 若同时设置了security_policy_id和tls_ciphers_policy，则仅security_policy_id生效。 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件（即支持ecc又支持rsa） security_policy_id String 自定义安全策略的ID。 使用说明： 仅对HTTPS协议类型的监听器且关联LB为独享型时有效。 若同时设置了security_policy_id和tls_ciphers_policy，则仅security_policy_id生效。 加密套件的优先顺序为ecc套件、rsa套件、tls1.3协议的套件（即支持ecc又支持rsa） enable_member_retry Boolean 是否开启后端服务器的重试。 取值：true 开启重试，false 不开启重试。默认：true。 使用说明： 若关联是共享型LB，仅在protocol为HTTP、TERMINATED_HTTPS时才能传入该字段。 若关联是独享型LB，仅在protocol为HTTP、HTTPS和QUIC时才能传入该字段。 keepalive_timeout Integer 客户端连接空闲超时时间。在超过keepalive_timeout时长一直没有请求， 负载均衡会暂时中断当前连接，直到下一次请求时重新建立新的连接。 取值： 若为TCP监听器，取值范围为（10-4000s）默认值为300s。 若为HTTP/HTTPS/TERMINATED_HTTPS监听器，取值范围为（0-4000s）默认值为60s。 UDP监听器不支持此字段。 client_timeout Integer 等待客户端请求超时时间，包括两种情况： 读取整个客户端请求头的超时时长：如果客户端未在超时时长内发送完整个请求头，则请求将被中断 两个连续body体的数据包到达LB的时间间隔，超出client_timeout将会断开连接。 取值范围为1-300s，默认值为60s。 使用说明：仅协议为HTTP/HTTPS的监听器支持该字段。 member_timeout Integer 等待后端服务器响应超时时间。请求转发后端服务器后，在等待超时member_timeout时长没有响应，负载均衡将终止等待，并返回 HTTP504错误码。 取值：1-300s，默认为60s。 使用说明：仅支持协议为HTTP/HTTPS的监听器。 ipgroup ListenerIpGroup object listener对象中的ipgroup信息 transparent_client_ip_enable Boolean 是否透传客户端IP地址。开启后客户端IP地址将透传到后端服务器。 仅作用于共享型LB的TCP/UDP监听器。 取值： 共享型LB的TCP/UDP监听器可设置为true或false，不传默认为false。 共享型LB的HTTP/HTTPS监听器只支持设置为true，不传默认为true。 独享型负载均衡器所有协议的监听器只支持设置为true，不传默认为true。 使用说明： 开启特性后，ELB和后端服务器之间直接使用真实的IP访问，需要确保已正确设置服务器的安全组以及访问控制策略。 开启特性后，不支持同一台服务器既作为后端服务器又作为客户端的场景。 开启特性后，不支持变更后端服务器规格。 proxy_protocol_enable Boolean 是否开启proxy_protocol。仅tcpssl监听器可指定，其他协议的监听器该字段不生效，proxy_protocol不开启。 enhance_l7policy_enable Boolean 是否开启高级转发策略功能。开启高级转发策略后，支持更灵活的转发策略和转发规则设置。 取值：true开启，false不开启，默认false。 开启后支持如下场景： 转发策略的action字段支持指定为REDIRECT_TO_URL, FIXED_RESPONSE，即支持URL重定向和响应固定的内容给客户端。 转发策略支持指定priority、redirect_url_config、fixed_response_config字段。 转发规则rule的type可以指定METHOD, HEADER, QUERY_STRING, SOURCE_IP这几种取值。 转发规则rule的type为HOST_NAME时，转发规则rule的value支持通配符*。 转发规则支持指定conditions字段。 缺省值：false quic_config ListenerQuicConfig object 当前监听器关联的QUIC监听器配置信息，仅protocol为HTTPS时有效。 对于TCP/UDP/HTTP/QUIC监听器，若该字段非空则报错。 说明： 客户端向服务端发送正常的HTTP协议请求并携带了支持QUIC协议的信息。 如果服务端监听器开启了升级QUIC，那么就会在响应头中加入服务端支持的QUIC端口和版本信息。 客户端再次请求时会同时发送TCP(HTTPS)和UDP(QUIC)请求，若QUIC请求成功，则后续继续使用QUIC交互。 protection_status String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 gzip_enable Boolean ELB是否开启gzip压缩，缺省值：false，非必选 仅HTTP/HTTPS/QUIC类型监听器支持配置。 port_ranges Array of PortRange objects 端口监听范围（闭区间)，最多指定10个端口组，每个组范围不可有重叠部分 说明： 仅当protocol_port为0时可以传入。 ssl_early_data_enable Boolean 监听器0-RTT能力开关，缺省值：false，非必选 仅HTTPS类型监听器支持配置，需要依赖TLSv1.3安全策略协议。 表5 ListenerInsertHeaders 参数 参数类型 描述 X-Forwarded-ELB-IP Boolean X-Forwarded-ELB-IP设为true可以将ELB实例的eip地址从报文的http头中带到后端云服务器。 X-Forwarded-Port Boolean X-Forwarded-Port设为true可以将ELB实例的监听端口从报文的http头中带到后端云服务器。 X-Forwarded-For-Port Boolean X-Forwarded-For-Port设为true可以将客户端的源端口从报文的http头中带到后端云服务器。 X-Forwarded-Host Boolean X-Forwarded-Host设为true可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器。 X-Forwarded-Proto Boolean X-Forwarded-Proto设为true可以将负载均衡器实例的监听协议通过报文的http头带到后端云服务器。 X-Real-IP Boolean X-Real-IP设为true可以将客户端的IP通过报文的http头带到后端云服务器。 X-Forwarded-ELB-ID Boolean X-Forwarded-ELB-ID设为true可以将负载均衡器实例的ID通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Certificate-ID Boolean X-Forwarded-TLS-Certificate-ID设为true可以将负载均衡器实例的证书ID通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Protocol Boolean X-Forwarded-TLS-Protocol设为true可以将负载均衡器实例的算法协议通过报文的http头带到后端云服务器。 X-Forwarded-TLS-Cipher Boolean X-Forwarded-TLS-Cipher设为true可以将负载均衡器实例的算法套件通过报文的http头带到后端云服务器。 表6 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表7 Tag 参数 参数类型 描述 key String 标签键 最小长度：1 最大长度：36 value String 标签值 最小长度：0 最大长度：43 表8 ListenerIpGroup 参数 参数类型 描述 ipgroup_id String 监听器关联的访问控制组的id。 创建时必选，更新时非必选。 指定的ipgroup必须已存在，不能指定为null，否则与enable_ipgroup冲突。 enable_ipgroup Boolean 访问控制组的状态。 True:开启访问控制； Flase：关闭访问控制； 开启访问控制的监听器，允许直接删除。 type String 访问控制组的类型。 white:白名单，只允许指定ip访问； black:黑名单，不允许指定ip访问； 表9 ListenerQuicConfig 参数 参数类型 描述 quic_listener_id String 监听器关联的QUIC监听器ID。 创建时必选，更新时非必选。 指定的listener id必须已存在，且协议类型为QUIC，不能指定为null，否则与enable_quic_upgrade冲突。 enable_quic_upgrade Boolean QUIC升级的开启状态。 True:开启QUIC升级； Flase：关闭QUIC升级； 开启HTTPS监听器升级QUIC监听器能力 表10 PortRange 参数 参数类型 描述 start_port Integer 起始端口 最小值：1 最大值：65535 end_port Integer 结束端口，需大于等于起始端口 最小值：1 最大值：65535

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

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 ELB.0002 RequestBody is null or empty,request is invalid. 请求body体为空。 参考接口指南填写参数。 400 ELB.0004 Api response is null or invaild. 请求返回为空。 检查后端服务是否正常。 400 ELB.0230 Tenant_id is empty. 项目ID为空。 输入正确项目ID。 400 ELB.1000 The loadbalancer URL is too long. URL的长度超出最大限制。 输入正确URL。 400 ELB.1001 Request parameters invalid. 参数不合法。 请输入合法的参数。 400 ELB.1003 Lb not exist. 该负载均衡器不存在。 检查输入的弹性负载均衡ID是否正确。 400 ELB.1004 Query condition is not valid. 查询条件不合法。 输入合法的查询条件。 400 ELB.1005 Update request paramters error. 修改ELB失败。 检查参数。 400 ELB.1007 Query internal ELB error. 查询私网ELB详情失败。 请联系客服处理。 400 ELB.1008 There is at least one member under the lb. 删除ELB失败。 输入正确参数。 400 ELB.1010 Query elb quota error. 查询quota失败。 请联系客服处理。 400 ELB.1011 Private_key or certificate content is not valid. 服务端证书公钥或私钥内容不合法。 请输入合法的证书公钥或私钥内容。 400 ELB.1012 Create tenant resource relation error. 创建资源用户对应关系失败。 请联系客服处理。 400 ELB.1013 Update resource tenant allocation failed, cloud eye warning rule exceeds. 修改资源用户配额失败，Cloud Eye告警规则过大。 请联系客服处理。 400 ELB.1014 Query resouce tenant relation failed. 查询资源用户对应关系失败。 请联系客服处理。 400 ELB.1015 Lb can not be updated. 该ELB不能被修改。 检查参数。 400 ELB.1018 There is at least one member under the lb. 该负载均衡器下有后端云服务器，不能直接删除。 请先移除后端服务器并删除关联的服务器组。 400 ELB.1020 Lb ID is not correct. 负载均衡器的ID不正确。 输入正确参数。 400 ELB.1021 Request parameters error, name invalid. 参数不合法，名称无效。 输入正确参数。 400 ELB.1025 Udpate request parameters error, name is too long. 修改ELB失败，名称长度超出最大限制。 修改ELB名称的长度。 400 ELB.1031 Request parameters error, lb len description too long. 参数不合法，描述长度超出最大限制。 输入合法长度的描述。 400 ELB.1035 Update request parameters error, name is not valid. 修改ELB失败，名称不合法。 修改ELB名称。 400 ELB.1041 Request parameters error, lb type is not valid. 参数不合法，类型无效。 输入正确参数。 400 ELB.1045 Update request parameters error, description too long. 修改ELB失败，参数不合法，描述长度超出最大限制。 修改ELB描述信息的长度。 400 ELB.1051 Request parameters error, lb bandwidth is not valid. 参数不合法，带宽无效。 输入正确的带宽。 400 ELB.1061 Request parameters error, lb vip_address and vip_subnet_id are nil. 参数不合法，弹性IP或子网ID为空。 输入正确的EIP或子网ID。 400 ELB.1071 Request parameters error, lb vip_address is not valid. 参数不合法，弹性IP无效。 输入正确的弹性IP。 400 ELB.1081 Request parameters error, lb vpc_id is empty. VPC ID为空。 输入正确的VPC ID。 400 ELB.1101 Vip address is exist. 该弹性IP已经存在。 输入正确的弹性IP。 400 ELB.1110 version not found. api版本号不存在。 请联系客服处理。 400 ELB.1201 Get Token failed 获取Token失败。 请联系客服处理。 400 ELB.1202 enterprise_project_id can not be empty ep_id校验出错。 检查企业ID是否合法。 400 ELB.1204 Bind fail. 绑定ep_id失败。 请联系客服处理。 400 ELB.2002 Delete member input param error. 删除后端云服务器失败，输入参数有误。 检查输入参数。 400 ELB.2003 Query member failed. 查询后端主机失败。 请联系客服处理。 400 ELB.2005 Update member failed. 更新后端主机失败。 请联系客服处理。 400 ELB.2010 Member listener ID length is not correct. 监听器ID的长度不合法。 输入合法长度的监听器ID。 400 ELB.2011 Add member listener is not exist. 请求的监听器不存在。 确认监听器是否存在。 400 ELB.2012 This member is not exist. 后端云服务器已经不存在。 确认member是否存在。 400 ELB.2020 Member listener ID content is not correct. 监听器ID不正确。 输入合法的监听器ID。 400 ELB.2021 Request parameters error, member address is null. 后端服务器IP地址无效，请检查。 检查IP地址。 400 ELB.3001 Create floating IP failed. 创建弹性IP失败。 请联系客服处理。 400 ELB.3002 Delete floating IP failed. 删除弹性IP失败。 请联系客服处理。 400 ELB.3003 Query floating IP failed. 查询弹性IP失败。 请联系客服处理。 400 ELB.3004 Query floating IP list failed. 查询弹性IP列表失败。 请联系客服处理。 400 ELB.4001 Create elastic IP failed. 创建弹性IP失败。 请联系客服处理。 400 ELB.4002 Delete elastic IP failed. 删除弹性IP失败。 请联系客服处理。 400 ELB.4003 Query elastic IP failed. 查询弹性IP失败。 请联系客服处理。 400 ELB.4004 Query elastic IP list failed. 查询弹性IP列表失败。 请联系客服处理。 400 ELB.4005 Update elastic IP failed. 更新弹性IP失败。 请联系客服处理。 400 ELB.5002 Failed to delete the certificate. 删除证书失败。 请联系客服处理。 400 ELB.5003 Query bandwidth failed. 查询带宽失败。 请联系客服处理。 400 ELB.5004 Invalid search criteria. 查询条件无效。 请确认输入正确的查询条件。 400 ELB.5005 Update bandwidth failed. 更新带宽失败。 请联系客服处理。 400 ELB.5013 Private_key or certificate content is not valid. 服务端证书公钥或私钥内容不合法。 请输入合法的证书公钥或私钥内容。 400 ELB.5020 The certificate ID must be 32 characters. 证书ID不是32位字符串。 请输入合法的证书ID。 400 ELB.5033 Failed to update certificate. 更新证书失败。 请联系客服处理。 400 ELB.5040 The certificate does not exist. 证书不存在。 请确认证书已经存在。 400 ELB.5051 CA certificate content is not valid. 客户端CA证书内容不合法。 请输入合法的证书内容。 400 ELB.5053 CA certificate content is not valid. 客户端CA证书内容不合法。 请输入合法的证书内容。 400 ELB.5131 Failed to query the certificate quota. 查找证书配额失败。 请联系客服处理。 400 ELB.5141 Failed to query the user certificate quota. 从证书查找配额使用记录失败。 请联系客服处理。 400 ELB.5151 The certificate quantity exceeds the quota. 证书数大于配额。 删除无用的证书或者提高配额。 400 ELB.6000 Listener ID length is not correct. 监听器ID长度不合法。 输入合法长度的监听器ID。 400 ELB.6001 Request parameters error, "..nilKey.." is nil. 请求参数不合法，必填字段为空。 输入必填字段。 400 ELB.6003 Listener query condition is not valid. 查询监听器列表条件不合法。 输入合法的查询条件。 400 ELB.6004 Query listeners list failed. 查询监听器列表失败。 请联系客服处理。 400 ELB.6006 Query server failed. 查询云主机失败。 请联系客服处理。 400 ELB.6010 Listener ID content is not correct. 监听器ID不合法。 输入合法的监听器ID。 400 ELB.6011 Request parameters error, listener name too long. 创建监听器失败，名称长度超出最大限制。 输入合法长度的监听器名称。 400 ELB.6015 This listener prerty cannot be updated 该监听器属性不能被修改。 指定的监听器属性不支持修改，请使用可被更新的监听器属性。 400 ELB.6021 Request parameters error, listener name is not valid. 创建监听器失败，名称不合法。 输入合法的监听器名称。 400 ELB.6025 Udpate request parameters error, listener len name too long. 修改监听器失败，名称长度超出最大限制。 输入合法长度的监听器名称。 400 ELB.6030 Listener is not associated with loadbalancer id. 该监听器不属于任何ELB。 检查输入的监听器。 400 ELB.6031 Request parameters error, listener len description too long. 创建监听器失败，描述长度超出最大限制。 输入合法长度的描述。 400 ELB.6035 Udpate request parameters error, listener name is not valid. 修改监听器失败，名称无效。 输入合法的监听器名称。 400 ELB.6040 The loadbalaner that the listener belongs to is not exist. 监听器所属负载均衡器不存在。 检查输入的弹性负载均衡ID是否正确。 400 ELB.6041 Request parameters error, listener port is not in 1 ~ 65535. 创建监听器失败，端口不合法。 输入合法的端口号。 400 ELB.6045 Update request parameters error, listener len description too long. 修改监听器失败，描述长度超出最大限制。 输入合法长度的监听器描述。 400 ELB.6051 Request parameters error, listener lb algorithm is not valid. 创建监听器失败，负载方式不合法。 输入合法的负载均衡算法。 400 ELB.6061 Request parameters error, listener protocol is not valid. 创建监听器失败，负载均衡协议不合法。 输入合法的负载均衡协议。 400 ELB.6071 Request parameters error, listener backend protocol is not valid. 创建监听器失败，后端云服务器协议不合法。 输入合法的后端协议。 400 ELB.6200 Load Balaner *** already has a listener with protocol_port of ***. listener端口号已占用，不能再创建。 使用新的端口创建监听器。 400 ELB.7000 Listener_id must not be null. 监听器ID为空。 输入合法的监听器ID。 400 ELB.7001 Healthcheck_interval is illegal. 修改健康检查条件不合法。 输入合法的删除条件。 400 ELB.7002 Healthcheck delete condition is not valid. 删除健康检查条件不合法。 输入合法的删除条件。 400 ELB.7004 Healthcheck query condition is not valid. 查询健康检查条件不合法。 输入合法的查询条件。 400 ELB.7010 Healthcheck listener is not exist. 该健康检查所属监听器不存在。 输入合法的监听器ID。 400 ELB.7014 Healthcheck configuration not exist. 健康检查配置不存在。 检查输入的健康检查ID是否存在。 400 ELB.7020 This healthcheck is not exist. 健康检查不存在。 输入合法的健康检查ID。 400 ELB.8001 Create a SG error. 创建安全组失败。 请联系客服处理。 400 ELB.8101 Create VPC error. 创建VPC失败。 请联系客服处理。 400 ELB.8102 Delete VPC error. 删除VPC失败。 请联系客服处理。 400 ELB.8103 Query VPC error. 查询VPC失败。 请联系客服处理。 400 ELB.8201 Create subnet error. 创建子网失败。 请联系客服处理。 400 ELB.8202 Delete subnet error. 删除子网失败。 请联系客服处理。 400 ELB.8203 Query subnet error. 查询子网失败。 请联系客服处理。 400 ELB.8902 Invalid input for '%s' is not in %s. 无效的请求参数。 检查请求参数。 400 ELB.8909 Certificate with multi domain not supported by guaranteed listener. 独享型LB的监听器不支持多域名证书。 检查请求参数。 400 ELB.8938 The ip member just support when pool's protocol is %s. 无效的请求参数。 将后端服务器添加到支持的后端服务器组下或在请求中添加subnet_cidr_id参数 400 ELB.8939 The loadbalancer's ip_target_enable must be true when add ip member. 无效的请求参数。 在请求参数中加入subnet_cidr_id 参数，或将LB的ip_target_enable为false。 400 ELB.8950 Cannot allocate resource for the loadbalancer. 无法为LB分配资源。 请联系客服处理。 400 ELB.8959 The %s flavor field does not support update from %s to %s. 更新LB的规格参数有误。 检查请求参数。 400 ELB.9001 Interval ELB create VM error. 创建server失败。 请联系客服处理。 400 ELB.9002 Internal ELB delete VM error. 删除server失败。 请联系客服处理。 400 ELB.9003 Internal ELB query VM error. 查询server详情失败。 请联系客服处理。 400 ELB.9006 Internal ELB update port fail. 更新server数据面port失败。 请联系客服处理。 400 ELB.9007 Intenal ELB bind port fail. 绑定server数据面port失败。 请联系客服处理。 400 ELB.9023 Internal ELB get image error. 查找镜像失败。 请联系客服处理。 400 ELB.9033 Internal ELB get flavour error. 查找server规格失败。 请联系客服处理。 400 ELB.9043 Internal ELB get interface error. 查询server绑定port失败。 请联系客服处理。 400 ELB.9061 Internal ELB query topic fail. 查询SMN群组失败。 请联系客服处理。 400 ELB.9062 Internal ELB create topic fail. 创建SMN群组失败。 请联系客服处理。 400 ELB.9063 Internal ELB query subscription fail. 查找SMN订阅失败。 请联系客服处理。 400 ELB.9064 Internal ELB create subscription fail. 创建SMN订阅失败。 请联系客服处理。 400 ELB.9800 Resource could not be found. 查找ep_id时指定资源loadbalancer_id不存在。 检查指定的load balancer是不是属于这个企业项目。 400 ELB.9801 Not be list action, enterprise_project_id must not be null. 细粒度场景下列表查询请求没有传递企业ID。 检查查询列表的请求，参数是否正确。 400 ELB.9805 RequestBody listener[protocol] is null, this is a required parameter. uri中的ep_id不是合法的uuid。 检查企业ID是否合法。 400 ELB.9807 Quota exceeded for resources: %s 资源配额不足。 如需扩大配额，请联系客服处理。 400 ELB.9899 Invalid parameter. For details about the error, see the returned information. 请求参数有误。详细错误请查看返回信息。 请检查请求参数。 401 ELB.1103 Token invalid Token不合法。 请联系客服处理。 401 ELB.1104 Token invalid Token不合法。 请联系客服处理。 401 ELB.1105 Token invalid Token不合法。 请联系客服处理。 401 ELB.1109 Authentication failed. 实名认证失败。 请联系客服处理。 403 ELB.1091 Lb number larger than quota. 负载均衡器数量超过配额。 修改配额或者删除不需要的LB。 403 ELB.1102 Token is error, Authentication required. token为空。 使用正确的未过期的token。 403 ELB.2001 Create member failed, the total amount of members exceeds the system setting. 创建云服务器失败，后端云服务器数量达到上限。 确认监听器下最大支持的云服务器数量。 403 ELB.6091 Request lb has more than user listener quota. 该ELB下的监听器数量达到上限。 提高配额或者删掉不用的监听器。 403 ELB.8962 tenant %s does not support %s. 当前租户%s不支持特性: %s 请联系客服处理。 403 ELB.9802 Policy doesn't allow elb:logtanks:create to be performed. 鉴权失败。 检查是否有权限执行该操作。 403 ELB.9803 Policy doesn't allow elb:loadbalancers:list to be performed. 鉴权失败。 检查是否有权限执行该操作。 403 ELB.9804 Policy doesn't allow elb:loadbalancers:list to be performed. 鉴权失败。 检查是否有权限执行该操作。 404 ELB.1002 Find lb failed. 该ELB不存在。 输入正确存在的ELB ID。 404 ELB.8904 %s %s could not be found. 请求资源不存在 请检查请求参数 409 ELB.8905 Quota exceeded for resources: %s 资源%s的资源不足。 如需扩大配额，请联系客服处理。 409 ELB.8907 Data conflict. For details about the error, see the returned information. 数据冲突。详细错误请查看返回信息。 请根据报错信息修改参数。 500 ELB.8906 Internal Server Error. 内部错误。详细错误请查看返回信息。 请联系客服处理。 503 ELB.6002 Delete listener failed, listener does not exist. 删除监听器失败，该监听器不存在。 检查监听器ID是否正确 父主题： 附录

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 page_info PageInfo object 分页信息。 pools Array of Pool objects 后端服务器组列表。 表5 PageInfo 参数 参数类型 描述 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 current_count Integer 当前的记录数。 表6 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字段指定端口。 表7 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表8 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表9 MemberRef 参数 参数类型 描述 id String 后端服务器ID。 表10 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。 表11 SlowStart 参数 参数类型 描述 enable Boolean 慢启动的开关，默认值：false； true：开启； false：关闭 缺省值：false duration Integer 慢启动的持续时间。取值：30~1200s，默认30s； 最小值：30 最大值：1200 缺省值：30

响应示例 状态码： 200 操作正常返回。 { "pools" : [ { "lb_algorithm" : "ROUND_ROBIN", "protocol" : "HTTP", "type" : "", "vpc_id" : "", "description" : "", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "309a0f61-0b62-45f2-97d1-742f3434338e" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : { "cookie_name" : "my_cookie", "type" : "APP_COOKIE", "persistence_timeout" : 1 }, "healthmonitor_id" : "", "listeners" : [ ], "members" : [ ], "id" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103", "name" : "", "ip_version" : "v4" }, { "lb_algorithm" : "SOURCE_IP", "protocol" : "TCP", "description" : "", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "d9763e59-64b7-4e93-aec7-0ff7881ef9bc" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : { "cookie_name" : "", "type" : "SOURCE_IP", "persistence_timeout" : 1 }, "healthmonitor_id" : "", "listeners" : [ { "id" : "8d21db6f-b475-429e-a9cb-90439b0413b2" } ], "members" : [ ], "id" : "74db02d1-5711-4c77-b383-a450e2b93142", "name" : "pool_tcp_001", "ip_version" : "dualstack" } ], "page_info" : { "next_marker" : "74db02d1-5711-4c77-b383-a450e2b93142", "previous_marker" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103", "current_count" : 2 }, "request_id" : "a1a7e852-1928-48f7-bbc9-ca8469898713" }

URI GET /v3/{project_id}/elb/pools 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 上一页最后一条记录的ID。 使用说明： 必须与limit一起使用。 不指定时表示查询第一页。 该字段不允许为空或无效的ID。 limit 否 Integer 每页返回的个数。 最小值：0 最大值：2000 缺省值：2000 page_reverse 否 Boolean 是否反向查询。 取值： true：查询上一页。 false：查询下一页，默认。 使用说明： 必须与limit一起使用。 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。 description 否 Array 后端云服务器组的描述信息。 支持多值查询，查询条件格式：description=xxx&description=xxx。 admin_state_up 否 Boolean 后端云服务器组的管理状态。 不支持该字段，请勿使用。 healthmonitor_id 否 Array 后端云服务器组关联的健康检查的ID。 支持多值查询，查询条件格式：healthmonitor_id=xxx&healthmonitor_id=xxx。 id 否 Array 后端云服务器组的ID。 支持多值查询，查询条件格式：id=xxx&id=xxx。 name 否 Array 后端云服务器组的名称。 支持多值查询，查询条件格式：name=xxx&name=xxx。 loadbalancer_id 否 Array 后端云服务器组绑定的负载均衡器ID。 支持多值查询，查询条件格式：loadbalancer_id=xxx&loadbalancer_id=xxx。 protocol 否 Array 后端云服务器组的后端协议。 取值：TCP、UDP、HTTP、HTTPS、QUIC和TCPSSL。 支持多值查询，查询条件格式：protocol=xxx&protocol=xxx。 lb_algorithm 否 Array 后端云服务器组的负载均衡算法。 取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。 支持多值查询，查询条件格式：lb_algorithm=xxx&lb_algorithm=xxx。 enterprise_project_id 否 Array 企业项目ID。不传时查询default企业项目"0"下的资源，鉴权按照default企业项目鉴权； 如果传值，则传已存在的企业项目ID或all_granted_eps（表示查询所有企业项目）进行查询。 支持多值查询，查询条件格式：enterprise_project_id=xxx&enterprise_project_id=xxx。 ip_version 否 Array 后端云服务器组支持的IP版本。 支持多值查询，查询条件格式：ip_version=xxx&ip_version=xxx。 member_address 否 Array 后端云服务器的IP地址。仅用于查询条件，不作为响应参数字段。 支持多值查询，查询条件格式：member_address=xxx&member_address=xxx。 member_device_id 否 Array 后端云服务器对应的弹性云服务器的ID。仅用于查询条件，不作为响应参数字段。 支持多值查询，查询条件格式：member_device_id=xxx&member_device_id=xxx。 member_deletion_protection_enable 否 Boolean 是否开启删除保护，false不开启，true开启，不传查询全部。 listener_id 否 Array 关联的监听器ID，包括通过l7policy关联的。 支持多值查询，查询条件格式：listener_id=xxx&listener_id=xxx。 member_instance_id 否 Array 后端云服务器ID。仅用于查询条件，不作为响应参数字段。 支持多值查询，查询条件格式：member_instance_id=xxx&member_instance_id=xxx。 vpc_id 否 Array 后端云服务器组关联的虚拟私有云的ID。 type 否 Array 后端服务器组的类型。 取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。 空字符串（""）：允许任意类型的后端 protection_status 否 Array 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护

响应消息 表2 响应参数 参数 参数类型 描述 loadbalancers Array 负载均衡器对象列表。详见表3。 loadbalancers_links Array 负载均衡器的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。详见表 表6 loadbalancers_links字段说明字段说明 表3 loadbalancer字段说明 参数 是否必选 参数类型 描述 name 否 String 负载均衡器名称。 支持的最大字符长度：255 description 否 String 负载均衡器的描述信息。 支持的最大字符长度：255 tenant_id 否 String 负载均衡器所在的项目ID。获取方法详见获取项目ID。 支持的最大字符长度：255 需要和token中的project_id一致。 project_id 否 String 此参数和tenant_id参数含义一样，均指负载均衡器所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 vip_subnet_id 是 String 负载均衡器所在的子网IPv4子网ID。 可通过查询子网列表接口GET {vpc的endpoint}/v2.0/subnets获取。 vip_address将从该子网中产生。 只支持指定IPv4的子网ID。暂不支持IPv6。 provider 否 String 负载均衡器的生产者。 取值范围：vlb。 vip_address 否 String 负载均衡器的内网IP。 该IP必须为vip_subnet_id字段指定的子网网段中的IP。若不指定，自动从vip_subnet_id字段指定的子网网段中生成一个IP地址。 支持的最大字符长度：64 admin_state_up 否 Boolean 负载均衡器的管理状态。 该字段为预留字段，暂未启用。默认为true。 表4 listeners字段说明 参数 参数类型 描述 id String 关联的监听器id 表5 pools字段说明 参数 参数类型 描述 id String 关联的后端服务器组id 表6 loadbalancers_links字段说明 参数 参数类型 描述 href String 负载均衡器的分页查询中上下页的链接。 rel String 上下页的提示信息。 取值范围：next、previous。next表示href是下一页的url，previous表示href是上一页的url。

响应示例 响应样例1 { "loadbalancers": [ { "description": "simple lb", "admin_state_up": true, "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "provisioning_status": "ACTIVE", "vip_subnet_id": "5328f1e6-ce29-44f1-9493-b128a5653350", "listeners": [ { "id": "45196943-2907-4369-87b1-c009b1d7ac35" } ], "vip_address": "10.0.0.2", "vip_port_id": "cbced4fe-6f6f-4fd6-9348-0c3d1219d6ca", "provider": "vlb", "pools": [ { "id": "21d49cf7-4fd3-4cb6-8c48-b7fc6c259aab" } ], "id": "a9729389-6147-41a3-ab22-a24aed8692b2", "operating_status": "ONLINE", "tags": [], "name": "loadbalancer1", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14" } ] } 响应样例2 { "loadbalancers": [ { "description": "", "provisioning_status": "ACTIVE", "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "admin_state_up": true, "provider": "vlb", "pools": [ { "id": "b13dba4c-a44c-4c40-8f6e-ce7a162b9f22" }, { "id": "4b9e765f-82ee-4128-911b-0a2d9ebc74c7" } ], "listeners": [ { "id": "21c41336-d0d3-4349-8641-6e82b4a4d097" } ], "vip_port_id": "44ac5d9b-b0c0-4810-9a9d-c4dbf541e47e", "operating_status": "ONLINE", "vip_address": "192.168.0.234", "vip_subnet_id": "9d60827e-0e5c-490a-8183-0b6ebf9084ca", "id": "e79a7dd6-3a38-429a-95f9-c7f78b346cbe", "tags": [], "name": "elb-robot", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14" } ], "loadbalancers_links": [ { "href": "https://network.Region.dc1.domainname.com/v2.0/lbaas/loadbalancers?limit=10&marker=e79a7dd6-3a38-429a-95f9-c7f78b346cbe&page_reverse=True", "rel": "previous" } ] }

请求示例 请求样例1 全量查询负载均衡器 GET https://{Endpoint}/v2.0/lbaas/loadbalancers 请求样例2 分页查询负载均衡器，每页1个负载均衡器，起始负载均衡器的ID为165b6a38-5278-4569-b747-b2ee65ea84a4，则查出的负载均衡器为165b6a38-5278-4569-b747-b2ee65ea84a4的下一个。 GET https://{Endpoint}/v2.0/lbaas/loadbalancers?limit=1&marker=165b6a38-5278-4569-b747-b2ee65ea84a4 请求样例3 过滤查询与IP为192.168.0.191的后端云服务器关联的负载均衡器 GET https://{Endpoint}/v2.0/lbaas/loadbalancers?member_address=192.168.0.181

请求消息 表1 请求参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID，表示上一页最后一条查询记录的负载均衡器的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的负载均衡器个数。 page_reverse 否 Boolean 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 tenant_id 否 String 负载均衡器所在项目的ID。 获取方法详见获取项目ID。 project_id 否 String 此参数和tenant_id参数含义一样，均指负载均衡器所在的项目ID。 获取方法详见获取项目ID。 id 否 String 负载均衡器的ID。 description 否 String 负载均衡器的描述信息。 支持的最大字符长度：255 name 否 String 负载均衡器的名称。 支持的最大字符长度：255 operating_status 否 String 负载均衡器的操作状态。取值范围：可以为ONLINE和FROZEN。 provisioning_status 否 String 该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 admin_state_up 否 Boolean 负载均衡器的管理状态。 该字段为预留字段，暂未启用。默认为true。 vip_address 否 String 负载均衡器的内网IP。 支持的最大字符长度：64 vip_port_id 否 String 负载均衡器内网IP对应的端口ID。 vip_subnet_id 否 String 负载均衡器所在的子网IPv4子网ID。 member_address 否 String 负载均衡器的后端服务器的IP地址。 member_device_id 否 String 负载均衡器的后端服务器对应的弹性云服务器ID。 vpc_id 否 String 负载均衡器所在的虚拟私有云ID。

响应参数 状态码： 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。

请求示例 更新IP地址组中的所有IP地址 PUT https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0 { "ipgroup" : { "name" : "test_ipg", "ip_list" : [ { "ip" : "192.168.1.123" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ] } }

响应示例 状态码： 200 操作正常返回。 { "ipgroup" : { "description" : "", "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "name" : "test_ipg", "project_id" : "45977fa2dbd7482098dd68d0d8970117", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ], "listeners" : [ { "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "created_at" : "2018-01-16T03:19:16", "updated_at" : "2018-01-16T03:19:16" } }

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

具体步骤 设置请求消息头。Postman中设置好头部信息，将获取到的Token放入头部，如下图： 图1 设置请求消息头-添加后端云服务器组 在Body标签中填写请求消息体。 图2 填写请求消息体-添加后端云服务器组 查询虚拟机的subnet_id和主网卡IP。 填写URL。 GET https://{VPCEndpoint}/v2.0/ports?device_id={ecs_id} 在响应体中获取primary_interface为true的port的subnet_id和ip_address。响应体示例如下： { "ports": [ { "id": "4813697b-62ba-4f4b-90e5-13bbbdec7198", "name": "", "status": "ACTIVE", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "d97b6b89-6aa2-4636-a86b-132eb4eb566e", "ip_address": "10.1.1.89" } ], "mac_address": "fa:16:3e:cb:8d:0a", "network_id": "1b76b9c2-9b7e-4ced-81bd-d13f7389d7c9", "tenant_id": "04dd36f978800fe22f9bc00bea090736", "project_id": "04dd36f978800fe22f9bc00bea090736", "device_id": "f738c464-b5c2-45df-86c0-7f436620cd54", "device_owner": "compute:cn-north-4a", "security_groups": [ "7a233393-5be2-4dff-8360-1558dd950f6e" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled": true, "created_at": "2019-11-19T09:28:38", "updated_at": "2019-11-19T09:28:39" }, { "id": "94971c39-46f0-443a-85e8-31cb7497c78e", "name": "", "status": "ACTIVE", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "8d944cda-1f29-4035-9681-ad8c5117fbc5", "ip_address": "192.168.0.11" } ], "mac_address": "fa:16:3e:5c:d2:57", "network_id": "1b76b9c2-9b7e-4ced-81bd-d13f7389d7c9", "tenant_id": "04dd36f978800fe22f9bc00bea090736", "project_id": "04dd36f978800fe22f9bc00bea090736", "device_id": "f738c464-b5c2-45df-86c0-7f436620cd54", "device_owner": "compute:cn-north-4a", "security_groups": [ "a10dfc31-0055-4b84-b36e-1291b918125c", "7a233393-5be2-4dff-8360-1558dd950f6e" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": { "primary_interface": true }, "binding:profile": {}, "port_security_enabled": true, "created_at": "2019-11-12T17:17:51", "updated_at": "2019-11-12T17:17:51" } ] } 填写URL。 https://{ELBEndpoint}/v2.0/lbaas/pools/{pool_id}/members 发送请求。body体中的subnet_id和address为步骤3中获取的值，选择请求方法为POST，点击Send按钮，得到服务端响应。 { "member": { "name": "member4j", "weight": 1, "admin_state_up": false, "subnet_id": "8d944cda-1f29-4035-9681-ad8c5117fbc5", "tenant_id": "0d0bf0e8fb564cc9abbe526dbdca9248", "address": "192.168.0.11", "protocol_port": 8080, "id": "97f18d73-e97d-434c-8cb7-3274a83dda73", "operating_status": "ONLINE" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ipgroup 是 CreateIpGroupOption object 创建IP地址组的请求体。 表4 CreateIpGroupOption 参数 是否必选 参数类型 描述 project_id 否 String IP地址组所在的项目ID。 最小长度：32 最大长度：32 description 否 String IP地址组的描述。 最小长度：0 最大长度：255 name 否 String IP地址组的名称。 最小长度：0 最大长度：255 ip_list 是 Array of CreateIpGroupIpOption objects IP地址组中包含的IP或网段列表。[]表示任意IP。 数组长度：0 - 300 enterprise_project_id 否 String IP地址组所在的企业项目ID。 表5 CreateIpGroupIpOption 参数 是否必选 参数类型 描述 ip 是 String IP地址。支持IPv4、IPv6。 description 否 String 备注信息。 最小长度：0 最大长度：255

响应参数 状态码： 201 表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。

响应示例 状态码： 201 POST操作正常返回。 { "ipgroup" : { "description" : "", "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "name" : "test_ipg", "project_id" : "45977fa2dbd7482098dd68d0d8970117", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ], "listeners" : [ { "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "created_at" : "2018-01-16T03:19:16", "updated_at" : "2018-01-16T03:19:16" } }