华为云用户手册

请求示例 请求样例1 全量查询后端云服务器 GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members 请求样例2 过滤查询IP为10.0.0.8且端口为80的后端云服务器 GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members?address=10.0.0.8&protocol_port=80

响应消息 表3 响应参数 参数 参数类型 描述 members Array 属于某个后端云服务器组的后端云服务器对象列表。对象详见表4。 members_links Array 后端云服务器的分页查询中上下页的链接信息。 仅当分页查询时响应体中有该字段。详见表5。 表4 members字段说明 参数 参数类型 描述 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和FROZEN。 表5 members_links字段说明 参数 参数类型 描述 href String 后端云服务器的分页查询中上下页的url。 rel String 上下页的提示信息，取值： next：表示href是下一页的URL previous：表示href是上一页的url

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID，表示上一页最后一条查询记录的后端云服务器的ID。不指定时表示查询第一页。 必须与limit一起使用。 limit 否 Integer 分页查询每页的后端云服务器个数。如果不设置，则默认不分页查询所有后端云服务器。 page_reverse 否 Boolean 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 id 否 String 后端云服务器的ID。 说明： 此处并非服务器的ID，而是ELB添加后端服务器之后自动生成的member ID。 tenant_id 否 String 后端云服务器所属的项目ID。 支持的最大字符长度：255 获取方法详见获取项目ID。 project_id 否 String 此参数和tenant_id参数含义一样，均指后端云服务器所属的项目ID。 获取方法详见获取项目ID。 name 否 String 后端云服务器的名称。 支持的最大字符长度：255 说明： 此处并非服务器的名称，而是ELB添加后端服务器之后生成的member名称。 address 否 String 后端云服务器对应的IP地址。 支持的最大字符长度：64 protocol_port 否 Integer 后端云服务器后端端口的协议号。 subnet_id 否 String 后端云服务器所在的子网ID。 admin_state_up 否 Boolean 后端云服务器的管理状态。 该字段为预留字段，暂未启用。默认为true。 weight 否 Integer 后端云服务器的权重。

请求示例 更新健康检查的检查间隔 PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/healthmonitors/c2b210b2-60c4-449d-91e2-9e9ea1dd7441 { "healthmonitor" : { "name" : "My Healthmonitor update", "max_retries" : 10, "delay" : 10 } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 healthmonitor HealthMonitor object 健康检查对象。 表6 HealthMonitor 参数 参数类型 描述 admin_state_up Boolean 健康检查的管理状态。 取值： true：表示开启健康检查，默认为true。 false表示关闭健康检查。 delay Integer 健康检查间隔。取值：1-50s。 最小值：1 最大值：50 domain_name String 发送健康检查请求的域名。 取值：以数字或字母开头，只能包含数字、字母、’-’、’.’。 默认为空，表示使用负载均衡器的vip作为http请求的目的地址。 使用说明：当type为HTTP/HTTPS时生效。 expected_codes String 期望响应状态码。 取值： 单值：单个返回码，例如200。 列表：多个特定返回码，例如200，202。 区间：一个返回码区间，例如200-204。 默认值：200。 仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。 http_method String HTTP请求方法。 取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH，默认GET。 使用说明：当type为HTTP/HTTPS时生效。 不支持该字段，请勿使用。 id String 健康检查ID max_retries Integer 健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围：1-10。 最小值：1 最大值：10 max_retries_down Integer 健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围：1-10，默认3。 最小值：1 最大值：10 monitor_port Integer 健康检查端口号。取值：1-65535，默认为空，表示使用后端云服务器端口号。 最小值：1 最大值：65535 name String 健康检查名称。 pools Array of PoolRef objects 健康检查所在的后端云服务器组ID列表。实际只会有一个后端云服务器组ID。 project_id String 健康检查所在的项目ID。 timeout Integer 一次健康检查请求的超时时间。 建议该值小于delay的值。 最小值：1 最大值：50 type String 健康检查请求协议。 取值：TCP、UDP_CONNECT、HTTP、HTTPS。 使用说明： 若pool的protocol为QUIC，则type只能是UDP_CONNECT。 若pool的protocol为UDP，则type只能UDP_CONNECT。 若pool的protocol为TCP，则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTP，则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTPS，则type可以是TCP、HTTP、HTTPS。 url_path String 健康检查请求的请求路径。以"/"开头，默认为"/"。 支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和and（&）以及扩展字符集_;~!()*[]@$^:',+ 使用说明：当type为HTTP/HTTPS时生效。 created_at String 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 updated_at String 更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 表7 PoolRef 参数 参数类型 描述 id String 后端服务器组ID。

响应示例 状态码： 200 操作正常返回。 { "request_id" : "08d6ffea-d092-4cfa-860a-e364f3bef1be", "healthmonitor" : { "monitor_port" : null, "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "domain_name" : null, "name" : "My Healthmonitor update", "delay" : 10, "max_retries" : 10, "pools" : [ { "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0" } ], "admin_state_up" : true, "timeout" : 30, "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", "http_method" : "GET" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM 鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 healthmonitor 是 UpdateHealthMonitorOption object 健康检查对象。 表4 UpdateHealthMonitorOption 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 健康检查的管理状态。 取值： true：表示开启健康检查，默认为true。 false表示关闭健康检查。 delay 否 Integer 健康检查间隔。健康检查间隔。取值：1-50s。 最小值：1 最大值：50 domain_name 否 String 发送健康检查请求的域名。 取值：以数字或字母开头，只能包含数字、字母、’-’、’.’。 不能传空，但可传null或不传，表示使用负载均衡器的vip作为http请求的目的地址。 使用说明：当type为HTTP/HTTPS时生效。 最小长度：1 最大长度：100 expected_codes 否 String 期望响应状态码。 取值： 单值：单个返回码，例如200。 列表：多个特定返回码，例如200，202。 区间：一个返回码区间，例如200-204。 默认值：200。 仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。 最小长度：1 最大长度：64 http_method 否 String HTTP请求方法。 取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH，默认GET。 使用说明：当type为HTTP/HTTPS时生效。 不支持该字段，请勿使用。 最小长度：1 最大长度：16 max_retries 否 Integer 健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围：1-10。 最小值：1 最大值：10 max_retries_down 否 Integer 健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围：1-10。 最小值：1 最大值：10 monitor_port 否 Integer 健康检查端口号。取值：1-65535，不可传入空，但可传入null，表示使用后端云服务器端口号。 最小值：1 最大值：65535 name 否 String 健康检查名称。 最小长度：0 最大长度：255 timeout 否 Integer 一次健康检查请求的超时时间。 建议该值小于delay的值。 最小值：1 最大值：50 url_path 否 String 健康检查请求的请求路径。以"/"开头，默认为"/"。 支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和and（&）以及扩展字符集_;~!()*[]@$^:',+ 使用说明：当type为HTTP/HTTPS时生效。 最小长度：1 最大长度：80 type 否 String 健康检查请求协议。 取值：TCP、UDP_CONNECT、HTTP、HTTPS。 使用说明： 若pool的protocol为QUIC，则type只能是UDP_CONNECT。 若pool的protocol为UDP，则type只能UDP_CONNECT。 若pool的protocol为TCP，则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTP，则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTPS，则type可以是TCP、HTTP、HTTPS。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应示例 状态码： 200 操作正常返回。 { "healthmonitor" : { "monitor_port" : null, "id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7441", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "domain_name" : null, "name" : "My Healthmonitor update", "delay" : 10, "max_retries" : 10, "pools" : [ { "id" : "488acc50-6bcf-423d-8f0a-0f4184f5b8a0" } ], "admin_state_up" : true, "timeout" : 30, "type" : "HTTP", "expected_codes" : "200", "url_path" : "/", "http_method" : "GET" }, "request_id" : "3702e8f0-f5f0-4d35-9097-fc7160005fae" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 healthmonitor HealthMonitor object 监看检查对象。 表4 HealthMonitor 参数 参数类型 描述 admin_state_up Boolean 健康检查的管理状态。 取值： true：表示开启健康检查，默认为true。 false表示关闭健康检查。 delay Integer 健康检查间隔。取值：1-50s。 最小值：1 最大值：50 domain_name String 发送健康检查请求的域名。 取值：以数字或字母开头，只能包含数字、字母、’-’、’.’。 默认为空，表示使用负载均衡器的vip作为http请求的目的地址。 使用说明：当type为HTTP/HTTPS时生效。 expected_codes String 期望响应状态码。 取值： 单值：单个返回码，例如200。 列表：多个特定返回码，例如200，202。 区间：一个返回码区间，例如200-204。 默认值：200。 仅支持HTTP/HTTPS设置该字段，其他协议设置不会生效。 http_method String HTTP请求方法。 取值：GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH，默认GET。 使用说明：当type为HTTP/HTTPS时生效。 不支持该字段，请勿使用。 id String 健康检查ID max_retries Integer 健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。取值范围：1-10。 最小值：1 最大值：10 max_retries_down Integer 健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。取值范围：1-10，默认3。 最小值：1 最大值：10 monitor_port Integer 健康检查端口号。取值：1-65535，默认为空，表示使用后端云服务器端口号。 最小值：1 最大值：65535 name String 健康检查名称。 pools Array of PoolRef objects 健康检查所在的后端云服务器组ID列表。实际只会有一个后端云服务器组ID。 project_id String 健康检查所在的项目ID。 timeout Integer 一次健康检查请求的超时时间。 建议该值小于delay的值。 最小值：1 最大值：50 type String 健康检查请求协议。 取值：TCP、UDP_CONNECT、HTTP、HTTPS。 使用说明： 若pool的protocol为QUIC，则type只能是UDP_CONNECT。 若pool的protocol为UDP，则type只能UDP_CONNECT。 若pool的protocol为TCP，则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTP，则type可以是TCP、HTTP、HTTPS。 若pool的protocol为HTTPS，则type可以是TCP、HTTP、HTTPS。 url_path String 健康检查请求的请求路径。以"/"开头，默认为"/"。 支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和and（&）以及扩展字符集_;~!()*[]@$^:',+ 使用说明：当type为HTTP/HTTPS时生效。 created_at String 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 updated_at String 更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 表5 PoolRef 参数 参数类型 描述 id String 后端服务器组ID。

响应示例 响应样例 { "listener": { "client_ca_tls_container_ref": "417a0976969f497db8cbb083bff343ba", "protocol": "TERMINATED_HTTPS", "description": "my listener", "default_tls_container_ref": "23b58a961a4d4c95be585e98046e657a", "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": 443, "tags": [], "default_pool_id": "c61310de-9a06-4f0c-850c-6f4797b9984c", "id": "f622c150-72f5-4263-a47a-e5003c652aa3", "name": "listener-jy-test2", "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" } }

请求示例 请求样例 更新监听器 PUT https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners/f622c150-72f5-4263-a47a-e5003c652aa3 { "listener": { "description": "my listener", "name": "listener-jy-test2", "default_tls_container_ref": "23b58a961a4d4c95be585e98046e657a", "client_ca_tls_container_ref": "417a0976969f497db8cbb083bff343ba", "default_pool_id": "c61310de-9a06-4f0c-850c-6f4797b9984c" } }

响应消息 表6 响应参数 参数 参数类型 描述 listener Listener object 监听器对象。详见表7。 表7 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。 表8 loadbalancers字段说明 参数 是否必选 参数类型 描述 id 是 String 关联的负载均衡器id 表9 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：关闭。 默认：开启。 表10 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

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 listener 是 Listener object 监听器对象。详见表3。 表3 listener字段说明 参数 是否必选 参数类型 描述 name 否 String 监听器名称。 注意：若名称为空，则在控制台的监听器列表无法选择并查看监听器详情。 支持的最大字符长度：255 description 否 String 监听器描述信息。 支持的最大字符长度：255 connection_limit 否 Integer 监听器最大连接数。 取值范围：[-1, 2147483647]。 该字段为预留字段，暂未启用，请勿使用。只有具有ELB管理员权限的用户可以指定。 http2_enable 否 Boolean HTTP2功能的开启状态。 取值范围：true/false。true：开启。false：关闭。 仅针对监听器的协议为TERMINATED_HTTPS有意义。 default_pool_id 否 String 监听器的默认后端云服务器组ID。 当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。当该字段为null时，表示监听器无默认的后端云服务器组。 default_pool_id有如下限制： 不能更新为其他监听器的default_pool。 不能更新为其他监听器关联的转发策略所使用的pool。 监听器和与之绑定的后端云服务器的对应关系如下： 监听器的protocol为TCP时，后端云服务器组的protocol必须为TCP。 监听器的protocol为UDP时，后端云服务器组的protocol必须为UDP。 监听器的protocol为HTTP或TERMINATED_HTTPS时，后端云服务器组的protocol必须为HTTP。 admin_state_up 否 Boolean 监听器的管理状态。 该字段为预留字段，暂未启用。默认为true。 default_tls_container_ref 否 String 监听器使用的服务器证书ID。 支持的最大字符长度：128 详细参见SSL证书管理。 当protocol参数为TERMINATED_HTTPS时，为必选字段。 client_ca_tls_container_ref 否 String 监听器使用的CA证书ID。 支持的最大字符长度：128 详细参见SSL证书管理。 sni_container_refs 否 Array 监听器使用的SNI证书（带域名的服务器证书）ID的列表。 该字段不为空列表时，SNI特性开启。该字段为空列表时，SNI特性关闭。 insert_headers 否 InsertHeaders object HTTP扩展头部，内部字段全量同步，不选则为默认值。 可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器上。 例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。详细参见表4。 说明： 仅当监听器的协议为HTTP、TERMINATED_HTTPS时，该字段有意义。 tls_ciphers_policy 否 String 监听器使用的安全策略，仅对TERMINATED_HTTPS协议类型的监听器有效。 取值包括：tls-1-0-inherit，tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表5。 表4 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：关闭。 默认：开启。 表5 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

接口约束 如果监听器关联的负载均衡器的provisioning status不是ACTIVE，则不能更新该监听器。 只有具有ELB管理员权限的用户才能指定connection_limit的值。 default_pool_id有如下限制： 不能更新为其他监听器的default_pool。 不能更新为其他监听器的关联的转发策略所使用的pool。 default_pool_id对应的后端云服务器组的protocol和监听器的protocol有如下关系： 监听器的protocol为TCP时，后端云服务器组的protocol必须为TCP。 监听器的protocol为UDP时，后端云服务器组的protocol必须为UDP。 监听器的protocol为HTTP或TERMINATED_HTTPS时，后端云服务器组的protocol必须为HTTP。

请求示例 示例1 : 创建一个私网IPv4负载均衡器 POST https://{ELB_Endponit}/v3/060576798a80d5762fafc01a9b5eedc7/elb/loadbalancers { "loadbalancer" : { "name" : "loadbalancer", "description" : "simple lb", "vip_subnet_cidr_id" : "1992ec06-f364-4ae3-b936-6a8cc24633b7", "admin_state_up" : true, "availability_zone_list" : [ "AZ1" ] } } 示例2 : 创建公网IPv4负载均衡器 POST https://{ELB_Endponit}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers { "loadbalancer" : { "vip_subnet_cidr_id" : "e6e9271d-aef4-48f0-a93a-ccc7b09032c1", "availability_zone_list" : [ "AZ1" ], "admin_state_up" : true, "publicip" : { "network_type" : "5_bgp", "bandwidth" : { "size" : 2, "share_type" : "PER", "charge_mode" : "bandwidth", "name" : "bandwidth_test" } }, "name" : "elb_eip-test" } }

响应示例 状态码： 201 POST操作正常返回。 { "loadbalancer" : { "name" : "my_loadbalancer", "id" : "29cc669b-3ac8-4498-9094-bdf6193425c2", "project_id" : "060576798a80d5762fafc01a9b5eedc7", "description" : "", "vip_port_id" : "98697944-0cc7-4d3b-a829-001c2fb82232", "vip_address" : "192.168.0.214", "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ ], "tags" : [ { "key" : "tab_key", "value" : "tag1" } ], "provider" : "vlb", "created_at" : "2023-03-22T07:59:57Z", "updated_at" : "2023-03-22T07:59:59Z", "vpc_id" : "a1f33a4c-95b9-48a7-9350-684e2ed844b3", "enterprise_project_id" : "134f2181-5720-47e7-bd78-1356ed3737d6", "availability_zone_list" : [ ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ { "publicip_id" : "3388574a-4f6f-4471-869e-97d74d21eee9", "publicip_address" : "88.88.87.205", "ip_version" : 4 } ], "global_eips" : [ ], "elb_virsubnet_ids" : [ ], "elb_virsubnet_type" : null, "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "public_border_group" : "center", "eips" : [ { "eip_id" : "3388574a-4f6f-4471-869e-97d74d21eee9", "eip_address" : "88.88.87.205", "ip_version" : 4 } ], "guaranteed" : false, "billing_info" : null, "l4_flavor_id" : null, "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "waf_failure_action" : "", "vip_subnet_cidr_id" : "abf31f3b-706e-4e55-a6dc-f2fcc707fd3a" }, "request_id" : "bf29597181cb81b30d19f1a0115a157d" }

响应参数 状态码： 201 表11 响应Body参数 参数 参数类型 描述 loadbalancer LoadBalancer object 负载均衡器对象。（包周期场景不返回该字段） loadbalancer_id String 负载均衡器的id 最小长度：0 最大长度：36 order_id String 订单号 最小长度：0 最大长度：36 request_id String 请求ID。 注：自动生成 。 最小长度：0 最大长度：36 表12 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 表13 PoolRef 参数 参数类型 描述 id String 后端服务器组ID。 表14 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表15 Tag 参数 参数类型 描述 key String 标签键 最小长度：1 最大长度：36 value String 标签值 最小长度：0 最大长度：43 表16 EipInfo 参数 参数类型 描述 eip_id String eip_id eip_address String eip_address ip_version Integer IP版本号。 取值：4表示IPv4,6表示IPv6。 表17 PublicIpInfo 参数 参数类型 描述 publicip_id String 弹性公网ip配置id publicip_address String IP地址 ip_version Integer IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6 表18 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 表19 BandwidthRef 参数 参数类型 描述 id String 共享带宽的id 表20 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 是 CreateLoadBalancerOption object 负载均衡器对象。 表4 CreateLoadBalancerOption 参数 是否必选 参数类型 描述 id 否 String 负载均衡器ID（UUID）。不支持该字段，请勿使用。 最小长度：0 最大长度：36 project_id 否 String 负载均衡器所在的项目ID。 最小长度：1 最大长度：32 name 否 String 负载均衡器的名称。 最小长度：0 最大长度：255 description 否 String 负载均衡器的描述。 最小长度：0 最大长度：255 vip_address 否 String 负载均衡器的IPv4虚拟IP。该地址必须包含在所在子网的IPv4网段内，且未被占用。 使用说明： 传入vip_address时必须传入vip_subnet_cidr_id。 不传入vip_address，但传入vip_subnet_cidr_id，则自动分配IPv4虚拟IP。 不传入vip_address，且不传vip_subnet_cidr_id，则不分配虚拟IP，vip_address=null。 vip_subnet_cidr_id 否 String 负载均衡器所在子网的IPv4子网ID。若需要创建带IPv4虚拟IP的LB，该字段必须传入。 可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到。 使用说明： vpc_id, vip_subnet_cidr_id, ipv6_vip_virsubnet_id不能同时为空，且需要在同一个vpc下。 若同时传入vpc_id和vip_subnet_cidr_id， 则vip_subnet_cidr_id对应的子网必须属于vpc_id对应的VPC。 最小长度：1 最大长度：36 ipv6_vip_virsubnet_id 否 String 双栈类型负载均衡器所在子网的IPv6网络ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的id得到。 使用说明： vpc_id，vip_subnet_cidr_id，ipv6_vip_virsubnet_id不能同时为空，且需要在同一个vpc下。 需要对应的子网开启IPv6。 provider 否 String 负载均衡器的生产者名称。固定为vlb。 最小长度：1 最大长度：255 l4_flavor_id 否 String 四层Flavor ID。 使用说明：当l4_flavor_id和l7_flavor_id都不传的时，会使用默认flavor （默认flavor根据不同局点有所不同，具体以实际值为准）。 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费； 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费 最小长度：1 最大长度：36 l7_flavor_id 否 String 七层Flavor ID。 使用说明：当l4_flavor_id和l7_flavor_id都不传的时，会使用默认flavor （默认flavor根据不同局点有所不同，具体以实际值为准）。 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费； 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费 最小长度：1 最大长度：36 guaranteed 否 Boolean 是否独享型负载均衡器。 取值： true：独享型。 false：共享型。 当前只支持设置为true，设置为false会返回400 Bad Request 。默认：true。 vpc_id 否 String 负载均衡器所在的VPC ID。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/vpcs 响应参数中的id得到。 使用说明： vpc_id，vip_subnet_cidr_id，ipv6_vip_virsubnet_id不能同时为空，且需要在同一个vpc下。 availability_zone_list 是 Array of strings 可用区列表。可通过GET https://{ELB_Endponit}/v3/{project_id}/elb/availability-zones 接口来查询可用区集合列表。创建负载均衡器时，从查询结果选择某一个可用区集合，并从中选择一个或多个可用区。 enterprise_project_id 否 String 负载均衡器所属的企业项目ID。不能传入""、"0"或不存在的企业项目ID，创建时不传则资源属于default企业项目，默认返回"0"。 tags 否 Array of Tag objects 负载均衡的标签列表。示例："tags":[{"key":"my_tag","value":"my_tag_value"}] admin_state_up 否 Boolean 负载均衡器的管理状态。只能设置为true。默认：true。 billing_info 否 String 资源账单信息。 取值： 空：按需计费。 最小长度：1 最大长度：1024 ipv6_bandwidth 否 BandwidthRef object 带宽对象ID，仅在创建或更新公网IPv6负载均衡器时有效。若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。 publicip_ids 否 Array of strings 负载均衡器绑定的公网IP ID。只支持绑定数组中的第一个EIP，其他将被忽略。 publicip 否 CreateLoadBalancerPublicIpOption object 创建ELB时，新建公网IP请求参数 elb_virsubnet_ids 否 Array of strings 下联面子网的网络ID列表。可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_network_id得到。 若不指定该字段，则按如下规则选择下联面网络： 如果ELB实例开启ipv6，则选择ipv6_vip_virsubnet_id子网对应的网络ID。 如果ELB实例没有开启ipv6，开启ipv4，则选择vip_subnet_cidr_id子网对应的网络ID。 如果ELB实例没有选择私网，只开启公网，则会在当前负载均衡器所在的VPC中任意选一个子网，优选可用IP多的网络。 若指定多个下联面子网，则按顺序优先使用第一个子网来为负载均衡器下联面端口分配ip地址。 下联面子网必须属于该LB所在的VPC。 ip_target_enable 否 Boolean 是否启用跨VPC后端转发。 开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。 仅独享型负载均衡器支持该特性。 取值： true：开启。 false：不开启。 使用说明： 开启不能关闭。 deletion_protection_enable 否 Boolean 是否开启删除保护。 取值：false不开启，true开启。默认false不开启。 说明： 退场时需要先关闭所有资源的删除保护开关。 prepaid_options 否 PrepaidCreateOption object 创建负载均衡器的包周期信息，若传入该结构体，则创建包周期的LB。 autoscaling 否 CreateLoadbalancerAutoscalingOption object 弹性扩缩容配置信息。负载均衡器配置并开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。 使用说明： 仅当租户白名单放开后该字段才有效 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 waf_failure_action 否 String WAF故障时的流量处理策略。discard:丢弃，forward: 转发到后端（默认） 使用说明：只有绑定了waf的LB实例，该字段才会生效。 缺省值：discard 最小长度：0 最大长度：36 protection_status 否 String 修改保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护 protection_reason 否 String 设置保护的原因 说明： 仅当protection_status为consoleProtection时有效。 最小长度：0 最大长度：255 charge_mode 否 String 创建实例采用的计费模式。flavor: 按实例规格收费，默认值。lcu: 按使用量收费。 最小长度：1 最大长度：255 ipv6_vip_address 否 String 双栈类型负载均衡器的IPv6地址。 表5 Tag 参数 是否必选 参数类型 描述 key 否 String 标签键 最小长度：1 最大长度：36 value 否 String 标签值 最小长度：0 最大长度：43 表6 BandwidthRef 参数 是否必选 参数类型 描述 id 是 String 共享带宽的id 表7 CreateLoadBalancerPublicIpOption 参数 是否必选 参数类型 描述 ip_version 否 Integer IP版本。 取值：4表示IPv4，6表示IPv6。 缺省值：4 network_type 是 String 弹性公网IP的网络类型，默认5_bgp，更多请参考弹性公网ip创建。 华南-深圳局点该参数取值只能为5_gray 最小长度：1 最大长度：36 billing_info 否 String 资源账单信息。 取值： 空：按需计费。 非空：包周期计费。 最小长度：1 最大长度：1024 description 否 String 弹性公网IP的描述信息，不支持特殊字符 最小长度：1 最大长度：255 bandwidth 是 CreateLoadBalancerBandwidthOption object bandwidth 表8 CreateLoadBalancerBandwidthOption 参数 是否必选 参数类型 描述 name 否 String 带宽名称。 取值：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 使用说明： 如果share_type是PER，该字段是必选。 如果bandwidth对象的id有值，该字段被忽略。 最小长度：1 最大长度：64 size 否 Integer 带宽大小 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。 注意:调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s:默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。 大于1000Mbit/s:默认最小单位为500Mbit/s。 使用说明：当id字段为null时，size是必须的。 最小值：0 最大值：99999 charge_mode 否 String 计费模式。 取值：bandwidth表示按带宽计费，traffic表示按流量计费。 使用说明：当id字段为null时，charge_mode是必须的。 最小长度：1 最大长度：36 share_type 否 String 带宽类型。 取值： PER：独享带宽。 WHOLE：共享带宽。 使用说明： 当id字段为null时，share_type是必须的。当id不为null时，该字段被忽略。 该字段为WHOLE时,必须指定带宽ID。 IPv6的EIP不支持WHOLE类型带宽。 billing_info 否 String 资源账单信息。 如果billing_info不为空，说明是包周期计费的带宽，否则为按需计费的带宽 最小长度：1 最大长度：1024 id 否 String 功能说明：使用已有的共享带宽创建IP 取值范围：共享带宽ID 使用说明： WHOLE类型的带宽ID； 在预付费的情况下，不填该值。该字段取空字符串时，会被忽略。 最小长度：1 最大长度：36 表9 PrepaidCreateOption 参数 是否必选 参数类型 描述 period_type 是 String 订购周期类型，当前支持包月和包年： month：月； year：年； period_num 否 Integer 订购周期数，取值会随运营策略变化。 period_type为month时，为[1,9]， period_type为year时，为[1,3] 最小值：1 最大值：9 缺省值：1 auto_renew 否 Boolean 是否自动续订； true：自动续订 false：不自动续订 缺省值：false auto_pay 否 Boolean 下单订购后，是否自动从客户的账户中支付； true：自动支付； false：不自动支付。 自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 缺省值：false 表10 CreateLoadbalancerAutoscalingOption 参数 是否必选 参数类型 描述 enable 是 Boolean 负载均衡器弹性扩缩容开关 缺省值：false min_l7_flavor_id 否 String 弹性扩缩容的最小七层规格ID，类型为L7_elastic，有七层监听器时，该字段不能为空。 该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。 最小长度：1 最大长度：36

功能介绍 创建负载均衡器。 若要创建内网IPv4负载均衡器，则需要设置vip_subnet_cidr_id。 若要创建公网IPv4负载均衡器，则需要设置publicip，以及设置vpc_id和vip_subnet_cidr_id这两个参数中的一个。 若要绑定有已有公网IPv4地址， 则需要设置publicip_ids，以及设置vpc_id和vip_subnet_cidr_id这两个参数中的一个。 若要创建内网双栈负载均衡器，则需要设置ipv6_vip_virsubnet_id。 若要创建公网双栈负载均衡器，则需要设置ipv6_vip_virsubnet_id和ipv6_bandwidth。 不支持绑定已有未使用的内网IPv4、内网IPv6或公网IPv6地址。 关于计费： 若billing_info非空时，包周期。 若billing_info为空，autoscaling.enable=true时，弹性计费。 若billing_info为空，autoscaling.enable=false或未设置，charge_mode=lcu，按量计费。 若billing_info为空，autoscaling.enable=false或未设置，charge_mode=flavor，固定规格按需计费。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 logtank 是 UpdateLogtankOption object 更新 云日志 请求参数。 表4 UpdateLogtankOption 参数 是否必选 参数类型 描述 log_group_id 否 String 日志组别id，其他（非ELB）服务提供 最小长度：1 最大长度：36 log_topic_id 否 String 日志订阅主题id，其他（非ELB）服务提供 最小长度：1 最大长度：36

请求示例 更新云日志 PUT https://{ELB_Endpoint}/v3/060576798a80d5762fafc01a9b5eedc7/elb/logtanks/603e507f-3e18-498b-9460-01a3b6c28fc5 { "logtank" : { "log_topic_id" : "5b9b8370-a1fc-4c59-a509-483a673c8a94", "log_group_id" : "7733882e-f7fa-4fb0-a460-0605c48a2280" } }

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

响应示例 状态码： 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" }

负载均衡器 权限 对应API接口 授权项（Action） IAM项目（Project） 企业项目（Enterprise Project） 创建ELB POST /v2/{project_id}/elb/loadbalancers elb:loadbalancers:create √ √ 查询ELB GET /v2/{project_id}/elb/loadbalancers/{loadbalancer_id} elb:loadbalancers:get √ √ 查询ELB状态树 GET /v2/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses elb:loadbalancers:get √ √ 查询ELB列表 GET /v2/{project_id}/elb/loadbalancers elb:loadbalancers:list √ √ 更新ELB PUT /v2/{project_id}/elb/loadbalancers/{loadbalancer_id} elb:loadbalancers:put √ √ 删除ELB DELETE /v2/{project_id}/elb/loadbalancers/{loadbalancer_id} elb:loadbalancers:delete √ √ 父主题： V2API授权项列表

响应消息 表3 响应参数 参数 参数类型 描述 whitelist Object 白名单对象。详见表4。 表4 whitelist字段说明 参数 参数类型 描述 id String 白名单的ID。 tenant_id String 白名单所在的项目ID。 支持的最大字符长度：255 listener_id String 白名单关联的监听器ID。 enable_whitelist Boolean 是否开启访问控制开关。 true：打开 false：关闭 whitelist String 白名单IP的字符串。

请求示例 请求样例 创建白名单 POST https://{Endpoint}/v2.0/lbaas/whitelists { "whitelist": { "listener_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" } }

请求消息 表1 请求参数 参数 是否必选 参数类型 描述 whitelist 是 Object 白名单对象。详见表2。 表2 whitelist字段说明 参数 是否必选 参数类型 描述 tenant_id 否 String 白名单所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 支持的最大字符长度：255 listener_id 是 String 监听器ID。 一个监听器只能创建一个白名单。 enable_whitelist 否 Boolean 是否开启访问控制开关。 true：打开 false：关闭 默认值：true。 whitelist 否 String 白名单IP的字符串。不同IP之间通过逗号分隔。 可以指定一个IP，例如： 192.168.11.1 也可以指定网段，例如： 192.168.0.1/24 默认值：“”。

响应示例 响应样例 { "whitelist": { "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" } }