华为云用户手册

请求示例 请求样例 POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/7add33ad-11dc-4ab9-a50f-419703f13163/tags { "tag": { "key": "key1", "value": "value1" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token 表3 请求参数 参数 是否必选 参数类型 描述 tag 是 Object 标签对象。详见表4。 表4 tag 字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 标签名称。 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value 是 String 标签值。 长度不超过43个字符。 由英文字母、数字、下划线、点、中划线、中文字符组成。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 rule L7Rule object 规则对象。 表4 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时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 表5 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

响应示例 状态码： 200 OK { "rule" : { "compare_type" : "STARTS_WITH", "provisioning_status" : "ACTIVE", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "invert" : false, "admin_state_up" : true, "value" : "/ccc.html", "key" : null, "type" : "PATH", "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7" }, "request_id" : "0d799435-259e-459f-b2bc-0beee06f6a77" }

操作步骤 创建监听器 发送“POST https://{elb_endpoint}/v3/{project_id}/elb/listeners”，project_id为项目ID。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： { "listener": { "protocol_port": 80, // 前端协议端口 "protocol": "HTTP", // 前端协议 "loadbalancer_id": "f77281cb-9f58-4347-8f82-2180d8bea789", // 关联的负载均衡器 "name": "my_listener" // 监听器名称 } } 查看请求响应结果。 请求成功时，响应参数如下： { "listener": { "id": "90ad2705-4ffd-43d3-8f75-af8086bde841", "name": "my_listener", "protocol_port": 80, "protocol": "HTTP", "description": "", "default_tls_container_ref": null, "admin_state_up": true, "loadbalancers": [ { "id": "f77281cb-9f58-4347-8f82-2180d8bea789" } ], "client_ca_tls_container_ref": null, "project_id": "057ef081eb00d2732fd1c01a9be75e6f", "sni_container_refs": [], "connection_limit": -1, "default_pool_id": null, "tls_ciphers_policy": null, "tags": [], "created_at": "2020-11-21T03:09:13Z", "updated_at": "2020-11-21T03:09:13Z", "http2_enable": false, "insert_headers": { "X-Forwarded-ELB-IP": false, "X-Forwarded-Host": true, "X-Forwarded-For-Port": false, "X-Forwarded-Port": false }, "member_timeout": 60, "client_timeout": 60, "keepalive_timeout": 60, "ipgroup": null, "enable_member_retry": true, "transparent_client_ip_enable": true }, "request_id": "fcd61ee6a6a6c673c65fa0df0577fed9" } 请求异常时，错误码请参见 错误码。

响应示例 响应样例 { "listener": { "protocol_port": 8000, "protocol": "TCP", "description": "", "client_ca_tls_container_ref": null, "default_tls_container_ref": null, "admin_state_up": true, "http2_enable": false, "loadbalancers": [ { "id": "3d77894d-2ffe-4411-ac0a-0d57689779b8" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "sni_container_refs": [], "connection_limit": -1, "default_pool_id": "b7e53dbd-62ab-4505-a280-5c066078a5c9", "id": "09e64049-2ab0-4763-a8c5-f4207875dc3e", "tags": [], "name": "listener-2", "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 响应参数 参数 参数类型 描述 listener Listener object 监听器对象。详见表3 listeners字段说明。 表3 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。 表4 loadbalancers字段说明 参数 是否必选 参数类型 描述 id 是 String 关联的负载均衡器id 表5 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：关闭。 默认：开启。 表6 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 { "certificate": "-----BEGIN CERTIFICATE----- \nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD \nb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAG \nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA \n0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5 \nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh9 \n7B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaS \nIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/K \ny09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0Wy \nYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29t \nhwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUA \nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn \njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa \nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ \nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI \n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ \niYsGDVN+9QBd0eYUHce+77s96i3I \n-----END CERTIFICATE-----", "create_time": "2017-02-25 09:35:27", "expire_time": "2045-11-17 13:25:47", "description": "description for certificate", "domain": "www.elb.com", "id": "23ef9aad4ecb463580476d324a6c71af", "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "admin_state_up": true, "name": "https_certificate", "private_key": "-----BEGIN PRIVATE KEY----- \nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M \n253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPe \ntB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rM \nMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXt \nCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2Chl \nZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08k \nEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/Hl \nfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQB \nZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKr \nciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9M \nEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7Ale \nkrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CT \nXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kx \nGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dt \nJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLr \niWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZ \nlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBU \nxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB \n1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAd \nXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak \n/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4Vha \nfI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf \n7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9o \njHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIuk \nfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd \n3fy+1rCUwzOp9LSjtJYf4ege \n-----END PRIVATE KEY-----", "type": "server", "update_time": "2017-02-25 09:35:27" }

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

响应示例 状态码： 200 操作正常返回。 { "request_id" : "01e84c2750b7217e5903b3d3bc9a9fda", "flavors" : [ { "name" : "L7_flavor.basic.elb.s1.small", "shared" : true, "project_id" : "060576798a80d5762fafc01a9b5eedc7", "info" : { "bandwidth" : 50000, "connection" : 200000, "cps" : 2000, "https_cps" : 200, "lcu" : 10, "qps" : 4000 }, "id" : "037418d4-8c9e-40b8-9e54-70ff4848fd82", "type" : "L7_basic", "flavor_sold_out" : false }, { "name" : "L4_flavor.elb.s2.small", "shared" : true, "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee", "info" : { "bandwidth" : 100000, "connection" : 1000000, "cps" : 20000, "lcu" : 20 }, "id" : "03925294-4ae2-4cdb-b912-cf171e782095", "type" : "L4", "flavor_sold_out" : false } ], "page_info" : { "next_marker" : "03925294-4ae2-4cdb-b912-cf171e782095", "previous_marker" : "037418d4-8c9e-40b8-9e54-70ff4848fd82", "current_count" : 2 } }

URI GET /v3/{project_id}/elb/flavors 表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。 id 否 Array 规格ID。 支持多值查询，查询条件格式：id=xxx&id=xxx。 name 否 Array 规格名称。 支持多值查询，查询条件格式：name=xxx&name=xxx。 type 否 Array 规格类别。 取值： L4和L7 表示四层和七层flavor。 L4_elastic和L7_elastic 表示弹性扩缩容实例的下限规格。 L4_elastic_max和L7_elastic_max 表示弹性扩缩容实例的上限规格。 支持多值查询，查询条件格式：type=xxx&type=xxx。 shared 否 Boolean 是否查询公共规格。true表示公共规格，所有租户可见。false表示私有规格，为当前租户所有。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 flavors Array of Flavor objects 规格列表。 page_info PageInfo object 规格分页信息。 request_id String 请求ID。 注：自动生成 。 表5 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。 表6 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有该指标。 表7 PageInfo 参数 参数类型 描述 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 current_count Integer 当前的记录数。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 pool MasterSlavePool object 后端服务器组对象。 表4 MasterSlavePool 参数 参数类型 描述 description String 后端云服务器组的描述信息。 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 MasterSlaveMember objects 后端云服务器组中的后端云服务器列表。 name String 后端云服务器组的名称。 project_id String 后端云服务器组所在的项目ID。 protocol String 后端云服务器组的后端协议。 取值：TCP、UDP、HTTP、HTTPS和QUIC。 使用说明： 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。 session_persistence SessionPersistence object 会话持久性对象。 ip_version String 后端云服务器组支持的IP版本。 取值： 共享型：固定为v4； 独享型：取值dualstack、v4、v6。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。 当协议为HTTP时，ip_version为v4。 created_at String 创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 updated_at String 更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。 vpc_id String 后端云服务器组关联的虚拟私有云的ID。 type String 后端服务器组的类型。 取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。 空字符串（""）：允许任意类型的后端 enterprise_project_id String 后端服务器组的企业项目ID。无论创建什么企业项目，都在默认企业项目下。 healthmonitor MasterSlaveHealthMonitor object 后端服务器组的健康检查。 any_port_enable Boolean 后端是否开启端口透传，开启后，后端服务器端口与前端监听器端口保持一致。取值：false不开启，true开启，默认false。 说明： 关闭端口透传后，请求会转发给后端服务器protocol_port字段指定端口。 表5 ListenerRef 参数 参数类型 描述 id String 监听器ID。 表6 LoadBalancerRef 参数 参数类型 描述 id String 负载均衡器ID。 表7 MasterSlaveMember 参数 参数类型 描述 id String 后端服务器ID。 name String 后端服务器名称。 admin_state_up Boolean 后端云服务器的管理状态。 取值：true、false。 虽然创建、更新请求支持该字段，但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。 subnet_cidr_id String 后端云服务器所在子网的IPv4子网ID或IPv6子网ID。 若所属的LB的跨VPC后端转发特性已开启，则该字段可以不传，表示添加跨VPC的后端服务器。 此时address必须为IPv4地址，所在的pool的协议必须为TCP/HTTP/HTTPS。 使用说明：该子网和关联的负载均衡器的子网必须在同一VPC下。 protocol_port Integer 后端服务器业务端口。 说明： 在开启端口透传的pool下创建member传该字段不生效，可不传该字段。 最小值：1 最大值：65535 address String 后端服务器对应的IP地址。 使用说明： 若subnet_cidr_id为空，表示添加跨VPC后端，此时address必须为IPv4地址。 若subnet_cidr_id不为空，表示是一个关联到ECS的后端服务器。该IP地址可以是IPv4或IPv6。 但必须在subnet_cidr_id对应的子网网段中。且只能指定为关联ECS的主网卡内网IP。 ip_version String 当前后端服务器的IP地址版本，由后端系统自动根据传入的address字段确定。取值：v4、v6。 device_owner String 设备所有者。 取值： 空，表示后端服务器未关联到ECS。 compute:{az_name}，表示关联到ECS，其中{az_name}表示ECS所在可用区名。 不支持该字段，请勿使用。 device_id String 关联的ECS ID，为空表示后端服务器未关联到ECS。 不支持该字段，请勿使用。 operating_status String 后端云服务器的健康状态。 取值： ONLINE：后端云服务器正常。 NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。 OFFLINE：后端云服务器关联的ECS服务器不存在或已关机。 member_type String 后端云服务器的类型。 取值： ip：跨VPC的member。 instance：关联到ECS的member。 instance_id String member关联的实例ID。空表示member关联的实例为非真实设备 （如：跨VPC场景） role String 后端服务器的主备状态。 status Array of ListenerMemberInfo objects 后端云服务器监听器粒度的的健康状态。 若绑定的监听器在该字段中，则以该字段中监听器对应的operating_status为准。 若绑定的监听器不在该字段中，则以外层的operating_status为准。 表8 ListenerMemberInfo 参数 参数类型 描述 listener_id String 后端服务器关联的监听器id。 operating_status String 后端云服务器的健康状态。 取值： ONLINE：后端云服务器正常。 NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。 OFFLINE：后端云服务器关联的ECS服务器不存在或已关机或服务异常。 表9 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。 表10 MasterSlaveHealthMonitor 参数 参数类型 描述 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 健康检查名称。 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时生效。

响应示例 状态码： 200 操作正常返回。 { "pool" : { "lb_algorithm" : "LEAST_CONNECTIONS", "type" : "ip", "vpc_id" : "3sae7086-a416-4666-9064-5b340e6840125", "protocol" : "TCP", "description" : "", "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor" : { "monitor_port" : null, "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "domain_name" : "", "name" : "My Healthmonitor", "max_retries" : 3, "max_retries_down" : 3, "admin_state_up" : true, "type" : "HTTP", "timeout" : 30, "delay" : 1, "http_method" : "get", "url_path" : "/", "expected_codes" : "200" }, "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" } ], "members" : [ { "admin_state_up" : true, "address" : "172.16.0.210", "protocol_port" : 80, "id" : "2e7b36d2-66c8-4825-bcd2-211d99978680", "operating_status" : "OFFLINE", "status" : [ ], "instance_id" : "", "device_id" : "", "device_owner" : "", "member_type" : "ip", "role" : "master", "ip_version" : "v4", "name" : "cx-test-master", "subnet_cidr_id" : "" }, { "admin_state_up" : true, "address" : "172.16.0.211", "protocol_port" : 81, "id" : "2e7b36d2-66c8-4823-bsd2-21sa199978681", "operating_status" : "OFFLINE", "status" : [ ], "instance_id" : "", "device_id" : "", "device_owner" : "", "member_type" : "ip", "role" : "slave", "ip_version" : "v4", "name" : "cx-test-slave", "subnet_cidr_id" : "" } ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool", "ip_version" : "dualstack", "created_at" : "2021-03-26T01:33:12Z", "updated_at" : "2021-03-26T01:33:12Z" }, "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e" }

响应示例 响应样例1 { "members": [ { "address": "10.0.0.8", "admin_state_up": true, "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", "protocol_port": 80, "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "weight": 1, "operating_status": "ONLINE", "name": "member-name" } ] } 响应样例2 { "members": [ { "address": "10.0.0.8", "admin_state_up": true, "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", "protocol_port": 80, "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "weight": 1, "operating_status": "ONLINE", "name": "member-name" } ] }

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

响应消息 表3 响应参数 参数 参数类型 描述 members Array of Members objects 属于某个后端云服务器组的后端云服务器对象列表。对象详见表4。 表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，后端服务器正常运行。 NO_MONITOR，后端服务器无健康检查。 OFFLINE，已下线。

API概览 通过使用弹性负载均衡服务所提供的接口，您可以完整的使用弹性负载均衡服务的所有功能。弹性负载均衡服务所提供的接口如表1所示。 表1 ELB接口说明 类型 子类型 说明 API（独享型） 负载均衡器 实现负载均衡器的创建、查询列表、查询详情、查询状态树、修改、删除等操作。 证书 实现证书的创建、查询列表、查询详情、修改、删除等操作。 安全策略 实现安全策略的创建、查询列表、查询详情、修改、删除等操作。 IP地址组 实现IP地址组的创建、查询列表、查询详情、修改、删除等操作。 监听器 实现监听器的创建、查询列表、查询详情、修改、删除等操作。 后端服务器组 实现后端服务器组的创建、查询列表、查询详情、修改、删除等操作。 后端服务器 实现后端服务器的创建、查询列表、查询详情、修改、删除等操作。 健康检查 实现健康检查的创建、查询列表、查询详情、修改、删除等操作。 转发策略 实现安全策略的创建、查询列表、查询详情、修改、批量更新优先级、删除等操作。 转发规则 实现转发规则的创建、查询列表、查询详情、修改、删除等操作。 共享型ELB接口 负载均衡器 实现负载均衡器创建、查询列表、查询详情、状态树查询、更新、删除等操作。 监听器 实现监听器的创建、查询列表、查询详情、更新、删除等操作。 后端云服务器组 实现后端云服务器组的创建、查询列表、查询详情、更新、删除等操作。 后端云服务器 实现后端云服务器的创建、查询列表、查询详情、更新、删除等操作。 健康检查 实现健康检查的创建、查询列表、查询详情、更新、删除等操作。 转发策略 实现转发策略的创建、查询列表、查询详情、更新、删除等操作。 转发规则 实现转发规则的创建、查询列表、查询详情、更新、删除等操作。 白名单 实现白名单的创建、查询列表、查询详情、更新、删除等操作。 SSL证书管理 实现证书的创建、查询列表、查询详情、更新、删除等操作。 共享型ELB OpenStack接口 负载均衡器 实现负载均衡器创建、查询列表、查询详情、状态树查询、更新、删除等操作。 监听器 实现监听器的创建、查询列表、查询详情、更新、删除等操作。 后端云服务器组 实现后端云服务器组的创建、查询列表、查询详情、更新、删除等操作。 后端云服务器 实现后端云服务器的创建、查询列表、查询详情、更新、删除等操作。 健康检查 实现健康检查的创建、查询列表、查询详情、更新、删除等操作。 转发策略 实现转发策略的创建、查询列表、查询详情、更新、删除等操作。 转发规则 实现转发规则的创建、查询列表、查询详情、更新、删除等操作。 白名单 实现白名单的创建、查询列表、查询详情、更新、删除等操作。 SSL证书管理 实现证书的创建、查询列表、查询详情、更新、删除等操作。 标签管理 实现负载均衡器和监听器的标签的创建、批量创建、查询、删除、批量删除等操作。

请求示例 请求样例 更新白名单 PUT https://{Endpoint}/v2.0/lbaas/whitelists/dcaf46f1-037c-4f63-a31f-e0c4c18032c7 { "whitelist": { "enable_whitelist": true, "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.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" } }

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

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 whitelist 是 Object 白名单对象。详见表3。 表3 whitelist字段说明 参数 是否必选 参数类型 描述 enable_whitelist 否 Boolean 是否开启访问控制开关。 true：打开 false：关闭 默认值：true。 whitelist 否 String 白名单IP的字符串。不同IP之间通过逗号分隔。 可以指定一个IP，例如： 192.168.11.1 也可以指定网段，例如： 192.168.0.1/24 默认值：“”。

请求示例 批量更新后端服务器。 POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-update { "members" : [ { "name" : "batch_update_member1", "weight" : 1, "admin_state_up" : true, "protocol_port" : 8080, "id" : "61da8098-954b-4809-bc5a-b99ccef8a398" }, { "name" : "batch_update_member2", "weight" : 2, "admin_state_up" : true, "protocol_port" : 8081, "id" : "61da8098-954b-4809-bc5a-b99ccef8a398" } ] }

响应示例 状态码： 200 操作正常返回。 { "request_id" : "b5d8bb34d28f3e47b352c14419e8fe04", "members" : [ { "weight" : 1, "admin_state_up" : false, "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d", "address" : "192.168.0.48", "protocol_port" : 8080, "id" : "9346ad28-6971-456a-9711-2917d023930a", "operating_status" : "OFFLINE", "name" : "batch_member1", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" }, { "weight" : 1, "admin_state_up" : false, "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d", "address" : "192.168.0.49", "protocol_port" : 8080, "id" : "94548801-1023-452f-bcf7-6174e77cb772", "operating_status" : "OFFLINE", "name" : "batch_member2", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of BatchUpdateMembersOption objects 后端服务器对象。 表4 BatchUpdateMembersOption 参数 是否必选 参数类型 描述 id 是 String 后端服务器ID。 说明： 此处并非ECS服务器的ID，而是ELB为绑定的后端服务器自动生成的member ID。 admin_state_up 否 Boolean 后端云服务器的管理状态。取值：true、false。 虽然创建、更新请求支持该字段，但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。 请勿传入该字段。 name 否 String 后端服务器名称。 最小长度：0 最大长度：255 protocol_port 否 Integer 后端服务器端口号。 最小值：1 最大值：65535 weight 否 Integer 后端云服务器的权重，请求按权重在同一后端云服务器组下的后端云服务器间分发。权重为0的后端不再接受新的请求。当后端云服务器所在的后端云服务器组的lb_algorithm的取值为SOURCE_IP时，该字段无效。 最小值：0 最大值：100

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注：自动生成 。 members Array of BatchUpdateMember objects 后端服务器对象列表。 表6 BatchUpdateMember 参数 参数类型 描述 id String 后端服务器ID。 说明： 说明： 此处并非ECS服务器的ID，而是ELB为绑定的后端服务器自动生成的member ID。 name String 后端服务器名称。 project_id String 后端服务器所在的项目ID。 admin_state_up Boolean 后端云服务器的管理状态。取值：true、false。 虽然创建、更新请求支持该字段，但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。 subnet_cidr_id String 后端云服务器所在子网的IPv4子网ID或IPv6子网ID。 若所属的LB的跨VPC后端转发特性已开启，则该字段可以不传，表示添加跨VPC的后端服务器。此时address必须为IPv4地址，所在的pool的协议必须为TCP/HTTP/HTTPS。 使用说明： 该子网和关联的负载均衡器的子网必须在同一VPC下。 protocol_port Integer 后端服务器业务端口号。 说明： 在开启端口透传的pool下的member，该字段不支持更新 最小值：1 最大值：65535 weight Integer 后端云服务器的权重，请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。 取值：0-100，默认1。 使用说明： 若所在pool的lb_algorithm取值为SOURCE_IP，该字段无效。 最小值：0 最大值：100 address String 后端服务器对应的IP地址。 使用说明： 若subnet_cidr_id为空，表示添加跨VPC后端，此时address必须为IPv4地址。 若subnet_cidr_id不为空，表示是一个关联到ECS的后端服务器。该IP地址可以是IPv4或IPv6。但必须在subnet_cidr_id对应的子网网段中。且只能指定为关联ECS的主网卡内网IP。 operating_status String 后端云服务器的健康状态。取值： ONLINE：后端云服务器正常。 NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。 OFFLINE：后端云服务器关联的ECS服务器不存在或已关机。 status Array of MemberStatus objects 后端云服务器监听器粒度的的健康状态。 若绑定的监听器在该字段中，则以该字段中监听器对应的operating_stauts为准。 若绑定的监听器不在该字段中，则以外层的operating_status为准。 member_type String 后端云服务器的类型。取值： ip：跨VPC的member。 instance：关联到ECS的member。 instance_id String member关联的实例ID，空表示跨VPC场景的member。 port_id String IP地址对应的VPC port ID 表7 MemberStatus 参数 参数类型 描述 listener_id String 监听器ID operating_status String 后端云服务器的健康状态。 取值： ONLINE：后端云服务器正常。 NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。 OFFLINE：后端云服务器关联的ECS服务器不存在或已关机。

响应消息 表4 响应参数 参数 参数类型 描述 l7policy L7policy object 转发策略对象。详见表5。 表5 l7policy字段说明 参数 参数类型 描述 id String 转发策略ID。 tenant_id String 转发策略所在的项目ID。 project_id String 此参数和tenant_id参数含义一样，均指转发策略所在的项目ID。 name String 转发策略名称。 admin_state_up Boolean 转发策略的管理状态； 该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。 description String 转发策略的描述信息。 listener_id String 转发策略所在的监听器ID。 action String 转发策略的匹配动作。 取值范围： REDIRECT_TO_POOL：将匹配的流量转发到redirect_pool_id指定的后端云服务器组上； REDIRECT_TO_LISTENER：将listener_id指定的HTTP监听器的流量重定向到redirect_listener_id指定的TERMINATED_HTTPS监听器上。 redirect_pool_id String 流量匹配后转发到后端云服务器组的ID。 redirect_listener_id String 流量匹配后转发到的监听器的ID。 redirect_url String 转发策略重定向到的url。 该字段为预留字段，暂未启用。 rules Array of Rules objects 转发策略关联的转发规则的ID列表。详见表7。 position Integer 转发优先级，从1递增，最高100。默认值：100； 该字段为预留字段，暂未启用。 provisioning_status String 该字段为预留字段，暂未启用。 转发策略的配置状态，可以为ACTIVE。 表6 rules字段说明 参数 参数类型 描述 id String 关联的转发规则id

响应示例 响应样例 { "l7policy": { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 2, "provisioning_status": "ACTIVE", "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "test" } }

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 l7policy 是 L7policy object 转发策略对象。表3。 表3 l7policy字段说明 参数 是否必选 参数类型 描述 name 否 String 转发策略名称。 支持的最大字符长度：255 description 否 String 转发策略的描述信息。 支持的最大字符长度：255 redirect_pool_id 否 String 流量匹配后转发到后端云服务器组的ID。默认值：null； 当action为REDIRECT_TO_POOL时为必选字段。 当action为REDIRECT_TO_LISTENER时，不可指定该字段。 指定的后端云服务器组需满足以下条件： 不能是监听器的default_pool； 不能是除该转发策略所在的监听器以外的其他监听器的转发策略使用的后端云服务器组。 redirect_listener_id 否 String 流量匹配后转发到的监听器的ID。默认值：null； 当action为REDIRECT_TO_LISTENER时为必选字段。 当action为REDIRECT_TO_POOL时不可指定。 只支持指定为protocol为TERMINATED_HTTPS的listener。 只支持指定为当前转发策略所在的负载均衡器下的监听器。 admin_state_up 否 Boolean 转发策略的管理状态。 该字段为预留字段，暂未启用。默认为true。

响应示例 状态码： 200 POST操作正常返回。 { "request_id" : "6c63d0ac-7beb-451d-a3e0-a066beaea316", "loadbalancer" : { "id" : "9b663cd9-61e4-483d-b91f-92fc337fecec", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-reset", "description" : "", "vip_port_id" : null, "vip_address" : null, "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ ], "tags" : [ ], "provider" : "vlb", "created_at" : "2021-07-26T02:46:31Z", "updated_at" : "2021-07-26T02:46:59Z", "vpc_id" : "59cb11ef-f185-49ba-92af-0539e8ff9734", "enterprise_project_id" : "0", "availability_zone_list" : [ "az1", "az2", "az3" ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ { "publicip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "publicip_address" : "97.97.2.171", "ip_version" : 4 } ], "elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ], "elb_virsubnet_type" : "dualstack", "ip_target_enable" : false, "autoscaling" : { "enable" : false, "min_l7_flavor_id" : "" }, "frozen_scene" : null, "eips" : [ { "eip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "eip_address" : "97.97.2.171", "ip_version" : 4 } ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "636ba721-935a-4ca5-a685-8076ce0e4148", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : null, "public_border_group" : "center", "protection_status" : "nonProtection", "protection_reason" : "" } }