华为云用户手册

  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求示例 添加云服务器请求样例 可以查询云服务器所属负载均衡器的vip_subnet_id及弹性云服务器的ip地址,得到subnet_id、ip_address; 或根据弹性云服务器id查询对应的subnet_id和address(GET https://{VPCEndpoint}/v2.0/ports?device_id={device_id}),其中device_id为弹性云服务器的id。取响应体中主网卡(primary_interface为true的port)的subnet_id、ip_address。 POST https://{Endpoint}/v2/145483a5107745e9b3d80f956713e6a3/elb/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members { "member": { "subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503", "protocol_port": 88, "name": "member-jy-tt-1", "address": "192.168.44.11" } }
  • 响应示例 响应样例 { "member": { "name": "member-jy-tt-1", "weight": 1, "admin_state_up": true, "subnet_id": "33d8b01a-bbe6-41f4-bc45-78a1d284d503", "tenant_id": "145483a5107745e9b3d80f956713e6a3", "project_id": "145483a5107745e9b3d80f956713e6a3", "address": "192.168.44.11", "protocol_port": 88, "operating_status": "ONLINE", "id": "c0042496-e220-44f6-914b-e6ca33bab503" } }
  • 请求消息 表2 请求参数 参数 是否必选 参数类型 描述 member 是 Member object 后端云服务器对象。详见表3。 表3 member字段说明 参数 是否必选 参数类型 描述 tenant_id 否 String 后端云服务器所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 支持的最大字符长度:255 name 否 String 后端云服务器的名称。默认为空字符串。 支持的最大字符长度:255 address 是 String 后端云服务器对应的IP地址,该IP必须在subnet_id字段指定子网的网段中。 只能对应主网卡的IP。 例如:192.168.3.11。 支持的最大字符长度:64 protocol_port 是 Integer 后端协议的端口号,取值范围[1,65535]。 subnet_id 是 String 后端云服务器所在的子网ID。 后端云服务器的address在该子网的网段中。 只支持指定IPv4的子网ID。暂不支持IPv6。 admin_state_up 否 Boolean 后端云服务器的管理状态。 该字段为预留字段,暂未启用。默认为true。 weight 否 Integer 后端云服务器的权重,取值范围[0,100]。 权重为0的后端不再接受新的请求。默认为1。
  • 响应消息 表4 响应参数 参数 参数类型 描述 member Member object member对象。详见表5。 表5 member字段说明 参数 参数类型 描述 id String 后端云服务器的 ID。 说明: 此处并非服务器的ID,而是ELB添加后端服务器之后自动生成的member ID。 tenant_id String 后端云服务器所在的项目ID。 支持的最大字符长度:255 project_id String 此参数和tenant_id参数含义一样,均指后端云服务器所在的项目ID。 name String 后端云服务器的名称。 支持的最大字符长度:255 address String 后端云服务器对应的IP地址,该IP必须在subnet_id字段指定子网的网段中,例如192.168.3.11。 只能对应主网卡的IP。 支持的最大字符长度:64 protocol_port Integer 后端端口的协议号,取值范围[1,65535]。 subnet_id String 后端云服务器所在的子网ID。后端云服务器的IP地址在该子网的网段中。 不支持开启了ipv6的子网。 admin_state_up Boolean 后端云服务器的管理状态。 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 weight Integer 后端云服务器的权重,取值范围[0,100]。 权重为0的后端不再接受新的请求。默认为1。 operating_status String 后端云服务器的健康状态,取值: ONLINE,后端服务器正常运行。 NO_MONITOR,后端服务器无健康检查。 OFFLINE,已下线。
  • 响应示例 响应样例1 action为filter时响应体 { "resources": [ { "resource_detail":"", "resource_id": "154d135b-3a89-4e89-8023-06efb9acdc05", "resource_name": "resouece1", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ], "total_count": 1000 } 响应样例2 action为count时响应体 { "total_count": 1000 }
  • 响应参数 表6 响应参数 参数 参数类型 描述 resources Array 监听器对象的列表。详见表7。 total_count Integer 总记录数。 表7 resource字段数据结构说明 参数 参数类型 描述 resource_id String 资源ID。 resource_detail String 资源详情。资源对象,用于扩展。默认为空。 tags Array 标签列表,没有标签默认为空数组。详见表8。 resource_name String 资源名称,没有默认为空字符串。 super_resource_id String 父级资源id 表8 tags 字段数据结构说明 参数 参数类型 描述 key String 键。最大长度127个unicode字符。key不能为空。(搜索时不对此参数做校验) value String 值。最大长度255个unicode字符。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token 表3 请求参数 参数 是否必选 参数类型 描述 tags 否 Array 包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。详见表4。 limit 否 Integer 查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1。 offset 否 Integer 索引位置,从offset指定的下一条数据开始查询,查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数。 action 是 String 操作标识(仅限于filter,count):filter(过滤)。count(查询总条数)如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。 matches 否 Array 搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值。 根据不同的字段确认是否需要模糊匹配,如resource_name默认为模糊搜索,如果value为空字符串精确匹配。key如果是resource_id则精确匹配。详见表5。 表4 tags 字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。最大长度127个unicode字符。key不能为空。(搜索时不对此参数做校验) values 是 Array 值列表。每个值最大长度255个unicode字符,value之间为或的关系。 表5 matches字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 取值范围: resource_name:资源名称; resource_id:资源ID; value 是 String 值。每个值最大长度255个unicode字符 。
  • 请求示例 请求样例1 action为filter时的请求体 POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/resource_instances/action { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } 请求样例2 action为count时的请求体 POST https://{Endpoint}/v2.0/6a0de1c3-7d74-4f4a-b75e-e57135bd2b97/listeners/resource_instances/action { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
  • 转发策略 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建l7policy POST /v2/{project_id}/elb/l7policies elb:l7policies:create √ √ 查询l7policy GET /v2/{project_id}/elb/l7policies/{ l7policy_id} elb:l7policies:get √ √ 查询l7policy列表 GET /v2/{project_id}/elb/l7policies elb:l7policies:list √ √ 更新l7policy PUT /v2/{project_id}/elb/l7policies/{l7policy_id} elb:l7policies:put √ √ 删除l7policy DELETE /v2/{project_id}/elb/l7policies/{l7policy_id} elb:l7policies:delete √ √ 父主题: V2API授权项列表
  • 响应示例 响应样例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/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0G CS qGSIb3DQEBCwUA\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce+77s96i3I\n-----END CERTIFICATE-----", "expire_time": "2045-11-17 13:25:47", "create_time": "2017-02-25 09:35:27", "update_time": "2017-02-25 09:38:27", "id": "23ef9aad4ecb463580476d324a6c71af", "description": "description for certificate", "domain": "www.elb.com", "type": "server", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "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-----" }
  • 请求示例 请求样例1 更新SSL证书 PUT https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/certificates/23ef9aad4ecb463580476d324a6c71af { "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-----", "description": "description for certificate", "domain": "www.elb.com", "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-----" }
  • 响应消息 表3 响应参数 参数 参数类型 描述 id String SSL证书ID。 tenant_id String SSL证书所在的项目ID。 支持的最大字符长度:255 admin_state_up Boolean SSL证书的管理状态; 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 name String SSL证书名称。 支持的最大字符长度:255 description String 证书描述SSL证书描述。 支持的最大字符长度:255 type String SSL证书的类型。 取值范围: server:服务端证书; client:客户端证书; domain String 服务端证书所签域名。 支持的最大字符长度:100 private_key String PEM格式的服务端私有密钥。 certificate String PEM格式的服务端公有密钥或者用于认证客户端证书的CA证书,由type字段区分。 expire_time String SSL证书的过期时间。 格式为UTC时间:YYYY-MM-DDTHH:MM:SS create_time String SSL证书的创建时间。 格式为UTC时间:YYYY-MM-DDTHH:MM:SS update_time String SSL证书的更新时间。 格式为UTC时间:YYYY-MM-DDTHH:MM:SS
  • 请求消息 表2 请求参数 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean SSL证书的管理状态; 该字段为预留字段,暂未启用。默认为true。 name 否 String SSL证书的名称。 支持的最大字符长度:255 description 否 String SSL证书的描述信息。 支持的最大字符长度:255 domain 否 String 服务端证书所签的域名。默认值:null; 支持的最大字符长度:100 取值范围: 普通域名由若干字符串组成,总长度为0-100,字符串间以"."分割,单个字符串长度不超过63个字符,只能包含英文字母、数字或"-",且必须以字母或数字开头和结尾。 泛域名在普通域名的基础上仅允许首字母为"*"。该字段仅type为server时有效。 说明: 该字段仅type为server时有效。 private_key 否 String HTTPS协议使用的私钥,PEM编码格式。 当type为client时,该参数被忽略,不影响证书的创建和使用。且若不符合格式,则该字段会设置为空。 当type为server时,该字段必须符合格式要求,且私钥必须是有效的,否则会报错。 certificate 否 String 服务端公有密钥证书或者用于认证客户端证书的CA证书,由type字段区分。 格式:证书为PEM格式。
  • 响应示例 状态码: 200 操作正常返回 { "request_id" : "c6f3d7fe99bb1d8aa29e148097dab0d0", "quota" : { "member" : 10000, "members_per_pool" : 1000, "certificate" : -1, "l7policy" : 2000, "listener" : 1500, "loadbalancer" : 100000, "healthmonitor" : -1, "pool" : 5000, "ipgroup" : 1000, "ipgroup_bindings" : 50, "ipgroup_max_length" : 300, "security_policy" : 50, "project_id" : "060576798a80d5762fafc01a9b5eedc7", "condition_per_policy" : 10, "listeners_per_pool" : 50, "listeners_per_loadbalancer" : 50 } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注:自动生成 。 quota Quota object 负载均衡相关各类资源的配额信息。仅返回资源的总配额,不包括剩余可用配额。 表4 Quota 参数 参数类型 描述 project_id String 项目ID。 loadbalancer Integer 负载均衡器配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 certificate Integer 证书配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 listener Integer 监听器配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 l7policy Integer 转发策略配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 condition_per_policy Integer 转发策略配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 pool Integer 后端云服务器组配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 healthmonitor Integer 健康检查配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 member Integer 后端云服务器配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 members_per_pool Integer 单个pool下的member的配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 listeners_per_pool Integer 单个pool下的member的配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 ipgroup Integer IP地址组配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 ipgroup_bindings Integer IP地址组配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 ipgroup_max_length Integer IP地址组配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 security_policy Integer 自定义安全策略配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。 listeners_per_loadbalancer Integer 单个LB实例下的监听器配额。 取值: 大于等于0:表示当前配额数量。 -1:表示无配额限制。
  • 监控指标 表1 ELB支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期 (原始指标) m1_cps 并发连接数 在四层负载均衡器中,指从测量对象到后端服务器建立的所有TCP和UDP连接的数量。 在七层负载均衡器中,指从客户端到ELB建立的所有TCP连接的数量。 单位:个 ≥ 0个 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 m2_act_conn 活跃连接数 从测量对象到后端服务器建立的所有ESTABLISHED状态的TCP或UDP连接的数量。 Windows和Linux服务器都可以使用如下命令查看。 netstat -an 单位:个 ≥ 0个 m3_inact_conn 非活跃连接数 从测量对象到所有后端服务器建立的所有除ESTABLISHED状态之外的TCP连接的数量。 Windows和Linux服务器都可以使用如下命令查看。 netstat -an 单位:个 ≥ 0个 m4_ncps 新建连接数 从客户端到测量对象每秒新建立的连接数。 单位:个/秒 ≥ 0个/秒 m5_in_pps 流入数据包数 测量对象每秒接收到的数据包的个数。 单位:个/秒 ≥ 0个/秒 m6_out_pps 流出数据包数 测量对象每秒发出的数据包的个数。 单位:个/秒 ≥ 0个/秒 m7_in_Bps 网络流入速率 从外部访问测量对象所消耗的流量。 单位:字节/秒 ≥ 0bytes/s m8_out_Bps 网络流出速率 测量对象访问外部所消耗的流量。 单位:字节/秒 ≥ 0bytes/s m9_abnormal_servers 异常主机数 健康检查统计监控对象后端异常的主机个数。 单位:个 ≥ 0个 独享型负载均衡器 共享型负载均衡器 1分钟 ma_normal_servers 正常主机数 健康检查统计监控对象后端正常的主机个数。 单位:个 ≥ 0个 m1e_server_rps 后端服务器重置数量 TCP监听器专属指标。后端服务器每秒通过测量对象发给客户端的重置(RST)数据包数。 单位:个/秒 ≥ 0个/秒 共享型负载均衡器 共享型负载均衡监听器 1分钟 m21_client_rps 客户端重置数量 TCP监听器专属指标。客户端每秒通过测量对象发送给后端服务器的重置(RST)数据包数。 单位:个/秒 ≥ 0个/秒 m1f_lvs_rps 负载均衡器重置数量 TCP监听器专属指标。测量对象每秒生成的重置(RST)数据包数。 单位:个/秒 ≥ 0个/秒 m22_in_bandwidth 入网带宽 从外部访问测量对象所消耗的带宽。 单位:比特/秒 ≥ 0bit/s 共享型负载均衡器 共享型负载均衡监听器 1分钟 m23_out_bandwidth 出网带宽 测量对象访问外部所消耗的带宽。 单位:比特/秒 ≥ 0bit/s mb_l7_qps 7层查询速率 统计测量对象当前7层查询速率。(HTTP和HTTPS监听器才有此指标) 单位:次/秒。 ≥ 0次/秒 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 md_l7_http_3xx 7层协议返回码(3XX) 统计测量对象当前7层3XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 mc_l7_http_2xx 7层协议返回码(2XX) 统计测量对象当前7层2XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 me_l7_http_4xx 7层协议返回码(4XX) 统计测量对象当前7层4XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 mf_l7_http_5xx 7层协议返回码(5XX) 统计测量对象当前7层5XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m10_l7_http_other_status 7层协议返回码(Others) 统计测量对象当前7层非2XX,3XX,4XX,5XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m11_l7_http_404 7层协议返回码(404) 统计测量对象当前7层404状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m12_l7_http_499 7层协议返回码(499) 统计测量对象当前7层499状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m13_l7_http_502 7层协议返回码(502) 统计测量对象当前7层502状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m14_l7_rt 7层协议RT平均值 统计测量对象当前7层平均响应时间。(HTTP和HTTPS监听器才有此指标) 从测量对象收到客户端请求开始,到测量对象将所有响应返回给客户端为止。 单位:毫秒。 说明: websocket场景下RT平均值可能会非常大,此时该指标无法作为时延指标参考。 ≥ 0ms m15_l7_upstream_4xx 7层后端返回码(4XX) 统计测量对象当前7层后端4XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 m16_l7_upstream_5xx 7层后端返回码(5XX) 统计测量对象当前7层后端5XX系列状态响应码的数量。 (HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m17_l7_upstream_rt 7层后端的RT平均值 统计测量对象当前7层后端平均响应时间。(HTTP和HTTPS监听器才有此指标) 从测量对象将请求转发给后端服务器开始,到测量对象收到后端服务器返回响应为止。 单位:毫秒。 说明: websocket场景下RT平均值可能会非常大,此时该指标无法作为时延指标参考。 ≥ 0ms m1a_l7_upstream_rt_max 7层后端的RT最大值 统计测量对象当前7层后端最大响应时间。(HTTP和HTTPS监听器才有此指标) 从测量对象将请求转发给后端服务器开始,到测量对象收到后端服务器返回响应为止。 单位:毫秒。 ≥ 0ms 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 m1b_l7_upstream_rt_min 7层后端的RT最小值 统计测量对象当前7层后端最小响应时间。(HTTP和HTTPS监听器才有此指标) 从测量对象将请求转发给后端服务器开始,到测量对象收到后端服务器返回响应为止。 单位:毫秒。 ≥ 0ms m1c_l7_rt_max 7层协议的RT最大值 统计测量对象当前7层最大响应时间。(HTTP和HTTPS监听器才有此指标) 从测量对象收到客户端请求开始,到测量对象将所有响应返回给客户端为止。 单位:毫秒。 ≥ 0ms 独享型负载均衡器 共享型负载均衡器 独享型负载均衡监听器 共享型负载均衡监听器 1分钟 m1d_l7_rt_min 7层协议的RT最小值 统计测量对象当前7层最小响应时间。(HTTP和HTTPS监听器才有此指标) 从测量对象收到客户端请求开始,到测量对象将所有响应返回给客户端为止。 单位:毫秒。 ≥ 0ms l7_con_usage 7层并发连接使用率 统计7层的ELB实例并发连接数使用率。 单位:百分比。 ≥ 0% 独享型负载均衡器 1分钟 l7_in_bps_usage 7层入带宽使用率 统计7层的ELB实例入带宽使用率。 单位:百分比 注意: 若入带宽使用率达到100%,说明已经超出ELB规格所提供的性能保障,您的业务可以继续使用更高带宽,但对于带宽超出的部分,ELB无法承诺服务可用性指标。 ≥ 0% l7_out_bps_usage 7层出带宽使用率 统计7层的ELB实例出带宽使用率。 单位:百分比 注意: 若出带宽使用率达到100%,说明已经超出ELB规格所提供的性能保障,您的业务可以继续使用更高带宽,但对于带宽超出的部分,ELB无法承诺服务可用性指标。 ≥ 0% l7_ncps_usage 7层新建连接数使用率 统计7层的ELB实例新建连接数使用率。 单位:百分比 ≥ 0% l7_qps_usage 7层查询速率使用率 统计7层的ELB实例查询速率使用率。 单位:百分比 ≥ 0% m18_l7_upstream_2xx 7层后端返回码(2XX) 统计测量对象当前7层后端2XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 独享型负载均衡后端服务器组 共享型负载均衡后端服务器组 1分钟 m19_l7_upstream_3xx 7层后端返回码(3XX) 统计测量对象当前7层后端3XX系列状态响应码的数量。(HTTP和HTTPS监听器才有此指标) 单位:个/秒。 ≥ 0个/秒 m25_l7_resp_Bps 7层响应带宽 统计周期时间内主机组的响应发送带宽。 单位:比特/秒 说明: 当监听器开启HTTP/2时,该指标无法作为参考。 ≥ 0bit/s m24_l7_req_Bps 7层请求带宽 统计周期时间内主机组的请求接收带宽。 单位:比特/秒 说明: 当监听器开启HTTP/2时,该指标无法作为参考。 ≥ 0bit/s l4_con_usage 4层并发连接使用率 统计4层的ELB实例并发连接数使用率。 单位:百分比 ≥ 0% 独享型负载均衡器 1分钟 l4_in_bps_usage 4层入带宽使用率 统计4层的ELB实例入带宽使用率。 单位:百分比 注意: 若入带宽使用率达到100%,说明已经超出ELB规格所提供的性能保障,您的业务可以继续使用更高带宽,但对于带宽超出的部分,ELB无法承诺服务可用性指标。 ≥ 0% l4_out_bps_usage 4层出带宽使用率 统计4层的ELB实例出带宽使用率。 单位:百分比 注意: 若出带宽使用率达到100%,说明已经超出ELB规格所提供的性能保障,您的业务可以继续使用更高带宽,但对于带宽超出的部分,ELB无法承诺服务可用性指标。 ≥ 0% l4_ncps_usage 4层新建连接数使用率 统计4层的ELB实例新建连接数使用率。 单位:百分比 ≥ 0% a:对于有多个测量维度的测量对象,使用接口查询监控指标时,所有测量维度均为必选。 查询单个监控指标时,多维度dim使用样例:dim.0=lbaas_instance_id,223e9eed-2b02-4ed2-a126-7e806a6fee1f&dim.1=lbaas_listener_id,3baa7335-8886-4867-8481-7cbba967a917。 批量查询监控指标时,多维度dim使用样例: "dimensions": [ { "name": "lbaas_instance_id", "value": "223e9eed-2b02-4ed2-a126-7e806a6fee1f" } { "name": "lbaas_listener_id", "value": "3baa7335-8886-4867-8481-7cbba967a917" } ],
  • 响应示例 响应样例 { "domain": "www.elb.com", "expire_time": "2045-11-17 13:25:47", "update_time": "2017-12-04 06:49:13", "create_time": "2017-12-04 06:49:13", "id": "3d8a7a02f87a40ed931b719edfe75451", "admin_state_up": true, "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-----", "tenant_id": "930600df07ac4f66964004041bd3deaf", "type": "server", "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-----", "name": "https_certificate", "description": "description for certificate" }
  • 请求示例 请求样例 创建SSL证书 POST https://{Endpoint}/v2/930600df07ac4f66964004041bd3deaf/elb/certificates { "name": "https_certificate", "description": "description for certificate", "type": "server", "domain": "www.elb.com", "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-----", "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-----" }
  • 响应消息 表3 响应参数 参数 参数类型 描述 id String SSL证书ID。 tenant_id String SSL证书所在的项目ID。 支持的最大字符长度:255 admin_state_up Boolean SSL证书的管理状态; 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 name String SSL证书名称。 支持的最大字符长度:255 description String 证书描述SSL证书描述。 支持的最大字符长度:255 type String SSL证书的类型。 取值范围: server:服务端证书; client:客户端证书; domain String 服务端证书所签域名。 支持的最大字符长度:100 private_key String PEM格式的服务端私有密钥。 certificate String PEM格式的服务端公有密钥或者用于认证客户端证书的CA证书,由type字段区分。 expire_time String SSL证书的过期时间。 格式为UTC时间:YYYY-MM-DDTHH:MM:SS create_time String SSL证书的创建时间。 格式为UTC时间:YYYY-MM-DDTHH:MM:SS update_time String SSL证书的更新时间。 格式为UTC时间:YYYY-MM-DDTHH:MM:SS
  • 请求消息 表2 查询参数 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean SSL证书的管理状态。 该字段为预留字段,暂未启用。默认为true。 name 否 String SSL证书的名称。 支持的最大字符长度:255 description 否 String SSL证书的描述信息。 支持的最大字符长度:255 type 否 String SSL证书的类型。默认值:server; 取值范围: server:服务端证书; client:客户端证书; domain 否 String 服务端证书所签的域名。默认值:null; 支持的最大字符长度:100 取值范围: 普通域名由若干字符串组成,总长度为0-100,字符串间以"."分割,单个字符串长度不超过63个字符,只能包含英文字母、数字或"-",且必须以字母或数字开头和结尾。 泛域名在普通域名的基础上仅允许首字母为"*"。 说明: 该字段仅type为server时有效。 private_key 否 String HTTPS协议使用的私钥,PEM编码格式。 当type为client时,该参数被忽略,不影响证书的创建和使用。且若不符合格式,则该字段会设置为空。 当type为server时,该字段必须符合格式要求,且私钥必须是有效的,否则会报错。 certificate 是 String 服务端公有密钥证书或者用于认证客户端证书的CA证书,由type字段区分。 格式:证书为PEM格式。 enterprise_project_id 否 String 企业项目ID。创建负载均衡器时,给负载均衡器绑定企业项目ID。 取值范围:带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。 默认值:"0"。 说明: 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。
  • 请求示例 示例1:创建后端服务器 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members { "member" : { "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74", "protocol_port" : 89, "name" : "My member", "address" : "120.10.10.16" } } 示例2:创建开启跨VPC的后端服务器 POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members { "member" : { "protocol_port" : 89, "name" : "My member", "address" : "120.10.10.16" } }
  • 响应示例 状态码: 201 POST操作正常返回。 { "member" : { "name" : "My member", "weight" : 1, "admin_state_up" : false, "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "address" : "120.10.10.16", "protocol_port" : 89, "id" : "1923923e-fe8a-484f-bdbc-e11559b1f48f", "operating_status" : "NO_MONITOR", "status" : [ { "listener_id" : "427eee03-b569-4d6c-b1f1-712032f7ec2d", "operating_status" : "NO_MONITOR" } ], "ip_version" : "v4" }, "request_id" : "f354090d-41db-41e0-89c6-7a943ec50792" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 member 是 CreateMemberOption object 后端服务器对象。 表4 CreateMemberOption 参数 是否必选 参数类型 描述 address 是 String 后端服务器对应的IP地址。 使用说明: 若subnet_cidr_id为空,表示添加跨VPC后端,此时address必须为IPv4地址。 若subnet_cidr_id不为空,表示是一个关联到ECS的后端服务器。该IP地址可以是IPv4或IPv6。 但必须在subnet_cidr_id对应的子网网段中。且只能指定为关联ECS的主网卡的内网IP。 最小长度:1 最大长度:64 admin_state_up 否 Boolean 后端云服务器的管理状态。 取值:true、false。 虽然创建、更新请求支持该字段,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。 name 否 String 后端云服务器名称。注意:该名称并非ECS名称,若不传则返回为空。 最小长度:0 最大长度:255 project_id 否 String 后端云服务器所在的项目ID。 最小长度:1 最大长度:32 protocol_port 否 Integer 后端服务器业务端口。 说明: 在开启端口透传的pool下创建member传该字段不生效,可不传该字段。 最小值:1 最大值:65535 subnet_cidr_id 否 String 后端云服务器所在的子网ID,可以是子网的IPv4子网ID或IPv6子网ID。 ipv4子网ID可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id得到 ipv6子网ID可以通过GET https://{VPC_Endpoint}/v1/{project_id}/subnets 响应参数中的neutron_subnet_id_v6得到 使用说明: 该子网和关联的负载均衡器的子网必须在同一VPC下。 若所属LB的跨VPC后端转发特性已开启,则该字段可以不传,表示添加跨VPC的后端服务器。 此时address必须为IPv4地址,所在的pool的协议必须为TCP/HTTP/HTTPS。 最小长度:1 最大长度:36 weight 否 Integer 后端云服务器的权重,请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。 权重值越大,分发的请求越多。权重为0的后端不再接受新的请求。 取值:0-100,默认1。 使用说明:若所在pool的lb_algorithm取值为SOURCE_IP,该字段无效。
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注:自动生成 。 member Member object 后端服务器对象。 表6 Member 参数 参数类型 描述 id String 后端服务器ID。 说明: 说明: 此处并非ECS服务器的ID,而是ELB为绑定的后端服务器自动生成的member ID。 name String 后端服务器名称。注意:该名称并非ECS名称。 project_id String 后端服务器所在的项目ID。 pool_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。 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 后端云服务器的健康状态。当status非空时,以status字段中监听器粒度的健康检查状态优先。 取值: ONLINE:后端云服务器正常。 NO_MONITOR:后端云服务器所在的服务器组没有健康检查器。 OFFLINE:后端云服务器关联的ECS服务器不存在或已关机。 status Array of MemberStatus objects 后端云服务器监听器粒度的的健康状态。 若绑定的监听器在该字段中,则以该字段中监听器对应的operating_stauts为准。 若绑定的监听器不在该字段中,则以外层的operating_status为准。 loadbalancer_id String 所属负载均衡器ID。 不支持该字段,请勿使用。 loadbalancers Array of ResourceID objects 后端云服务器关联的负载均衡器ID列表。 不支持该字段,请勿使用。 created_at String 创建时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 updated_at String 更新时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 member_type String 后端云服务器的类型。 取值: ip:跨VPC的member。 instance:关联到ECS的member。 instance_id String member关联的实例ID。空表示member关联的实例为非真实设备 (如:跨VPC场景) 表7 MemberStatus 参数 参数类型 描述 listener_id String 监听器ID operating_status String 后端云服务器的健康状态。 取值: ONLINE:后端云服务器正常。 NO_MONITOR:后端云服务器所在的服务器组没有健康检查器。 OFFLINE:后端云服务器关联的ECS服务器不存在或已关机。 表8 ResourceID 参数 参数类型 描述 id String 资源ID
  • 接口约束 1.同一个pool下的两个member不能有相同的address和port。 2.若所属LB开启跨VPC特性,创建member时可以不指定的子网,表示创建跨VPC的后端服务器。 此时address必须为ipv4地址,pool的协议必须为TCP/HTTP/HTTPS。 3.创建member时若指定了子网,则该子网必须和负载均衡器所在子网处在同一个VPC下。 4.如果pool是dualstack的,address支持IPv4格式也支持IPv6格式, 如果pool是v4的,address 只支持IPv4。
  • 响应示例 状态码: 201 POST操作正常返回。 { "request_id" : "6b50d914-41f2-4e50-8929-e8a9837dbe75", "security_policy" : { "id" : "d74e27c9-4d60-427c-a11f-21142117c433", "name" : "test_1", "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "description" : "test1", "protocols" : [ "TLSv1.2", "TLSv1", "TLSv1.3" ], "ciphers" : [ "ECDHE-ECDSA-AES128-SHA", "TLS_AES_128_GCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ], "listeners" : [ ], "created_at" : "2021-03-26T01:33:12Z", "updated_at" : "2021-03-26T01:33:12Z" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 security_policy 是 CreateSecurityPolicyOption object 创建自定义安全策略的请求体。 表4 CreateSecurityPolicyOption 参数 是否必选 参数类型 描述 name 否 String 自定义安全策略的名称。默认空字符串""。 最小长度:0 最大长度:255 description 否 String 自定义安全策略的描述信息。默认空字符串""。 最小长度:0 最大长度:255 enterprise_project_id 否 String 所属企业项目ID。 protocols 是 Array of strings 自定义安全策略选择的TLS协议列表。取值:TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 数组长度:1 - 5 ciphers 是 Array of strings 自定义安全策略的加密套件列表。支持以下加密套件: 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,CAMELLIA128-SHA, DES-CBC3-SHA,CAMELLIA256-SHA,ECDHE-RSA-CHACHA20-POLY1305, ECDHE-ECDSA-CHACHA20-POLY1305,TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256,TLS_AES_128_CCM_8_SHA256 使用说明: 协议和加密套件必须匹配,即ciphers中必须至少有一种有与协议匹配的加密套件。 说明: 协议与加密套件的匹配关系可参考系统安全策略 数组长度:1 - 30
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 security_policy SecurityPolicy object 安全策略列表返回对象。 request_id String 请求ID。 注:自动生成 。 表6 SecurityPolicy 参数 参数类型 描述 id String 自定义安全安全策略的id。 project_id String 自定义安全策略的项目id。 name String 自定义安全策略的名称 description String 自定义安全策略的描述。 listeners Array of ListenerRef objects 自定义安全策略关联的监听器。 protocols Array of strings 自定义安全策略的TLS协议列表。 ciphers Array of strings 自定义安全策略的加密套件列表。 created_at String 自定义安全策略的创建时间。 updated_at String 自定义安全策略的更新时间。 表7 ListenerRef 参数 参数类型 描述 id String 监听器ID。
共100000条