华为云用户手册

  • URI GET /v3/{project_id}/elb/quotas/details 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 quota_key 否 Array 资源类型。 取值: loadbalancer、listener、ipgroup、pool、member、healthmonitor、l7policy、certificate、security_policy、listeners_per_loadbalancer、listeners_per_pool、members_per_pool、condition_per_policy、ipgroup_bindings、ipgroup_max_length。 支持多值查询,查询条件格式:quota_key=xxx"a_key=xxx。
  • 响应示例 响应样例 { "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/735uP20KKqhNehZpC2dJei7OiIgRh CS /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.0/lbaas/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-----" }
  • 响应消息 表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
  • 请求消息 表1 请求参数 参数 是否必选 参数类型 描述 tenant_id 否 String SSL证书所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 支持的最大字符长度:255 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格式。
  • API版本选择建议 弹性负载均衡器所提供的API分为v2.0/v2/v3版本。 v2.0和v2接口适用于共享型负载均衡器,其中主版本为v2.0,v2主要适用于开通企业项目的用户为负载均衡器分配企业项目,进行细粒度授权。 整体API及对应功能列表详见API概览。为了满足用户对接OpenStack社区开源工具的诉求,我们v2.0的部分API兼容OpenStack API v2,两者功能相近,风格略有差异。 v3接口适用于独享型负载均衡器,独享型负载均衡实例的性能不受其它实例的影响,您可根据业务需要选择不同规格的实例。具有高性能、高可用、超安全、多协议支持以及更灵活的分发策略定制等优势。同时也支持企业项目功能。 各个版本API选择建议如下: 如果您开发工具对于OpenStack兼容性有要求,建议选择ELB API v2.0相关接口。 如果您使用VPC、ECS的Openstack API创建了vpc和ecs的资源,建议和ELB API v2.0配套一起使用。 如果您开通了企业项目功能,建议选择ELB API v2相关接口。 如果您需要更高的性能支持或更加灵活的负载均衡策略定制,则建议选择ELB APIv3相关接口。 父主题: 使用前必读
  • 响应示例 响应样例 { "rule": { "compare_type": "EQUAL_TO", "provisioning_status": "ACTIVE", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "/index.html", "key": null, "type": "PATH", "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" } }
  • 响应消息 表2 响应参数 参数 参数类型 描述 rule Object 转发规则对象。详见表3。 表3 rule字段说明 参数 参数类型 描述 id String 转发规则ID tenant_id String 转发规则所在的项目ID。 支持的最大字符长度:255 project_id String 此参数和tenant_id参数含义一样,均指转发规则所在的项目ID。 admin_state_up Boolean 转发规则的管理状态; 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 type String 转发规则的匹配类型。 取值范围: HOST_NAME:匹配请求中的域名; PATH:匹配请求中的路径; compare_type String 转发匹配方式: type为HOST_NAME时,取值范围: EQUAL_TO:精确匹配; type为PATH时,取值范围: REGEX:正则匹配; STARTS_WITH:前缀匹配; EQUAL_TO:精确匹配。 invert Boolean 是否反向匹配; 取值范围:true/false。默认值:false; 该字段为预留字段,暂未启用。 key String 匹配内容的键值。默认为null。 该字段为预留字段,暂未启用。 支持的最大字符长度:255 value String 匹配内容的值。 支持的最大字符长度:128 当type为HOST_NAME时,取值范围:String (100),字符串只能包含英文字母、数字、“-”或“.”,且必须以字母或数字开头。 当type为PATH时,取值范围:String (128)。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时,字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:| \/()[]{},且必须以"/"开头。 provisioning_status String 该字段为预留字段,暂未启用。 转发规则的配置状态,可以为ACTIVE。
  • 响应示例 状态码: 200 操作正常返回。 { "certificates" : [ { "id" : "5494a835d88f40ff940554992f2f04d4", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "name" : "https_certificatekkkk", "type" : "server", "domain" : null, "description" : "description for certificatehhhh", "private_key" : "-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPetB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rMMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXtCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2ChlZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08kEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/HlfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQBZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKrciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9MEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7AlekrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CTXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kxGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dtJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLriWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBUxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAdXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4VhafI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9ojHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIukfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd3fy+1rCUwzOp9LSjtJYf4ege-----END PRIVATE KEY-----", "certificate" : "-----BEGIN CERTIFICATE-----MIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlDb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5U0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh97B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaSIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/Ky09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0WyYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29thwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAnjiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDaezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZiYsGDVN+9QBd0eYUHce+77s96i3I-----END CERTIFICATE-----", "admin_state_up" : true, "created_at" : "2019-04-21T18:59:43Z", "updated_at" : "2019-04-21T18:59:43Z", "expire_time" : "2045-11-17T13:25:47Z" }, { "id" : "7875ccb4c6b44cdb90ab2ab89892ab71", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "name" : "https_certificatekkkk", "type" : "client", "domain" : "sda.com", "description" : "description for certificatehhhh", "private_key" : "-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPetB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rMMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXtCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2ChlZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08kEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/HlfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQBZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKrciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9MEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7AlekrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CTXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kxGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dtJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLriWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBUxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAdXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4VhafI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9ojHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIukfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd3fy+1rCUwzOp9LSjtJYf4ege-----END PRIVATE KEY-----", "certificate" : "-----BEGIN CERTIFICATE-----MIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlDb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5U0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh97B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaSIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/Ky09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0WyYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29thwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAnjiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDaezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZiYsGDVN+9QBd0eYUHce+77s96i3I-----END CERTIFICATE-----", "admin_state_up" : true, "created_at" : "2018-10-29T20:16:17Z", "updated_at" : "2019-04-06T21:33:24Z", "expire_time" : "2045-11-17T13:25:47Z" }, { "id" : "7f41c96223d34ebaa3c8e836b6625ec0", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "name" : "asdf", "type" : "server", "domain" : "sda.com", "description" : "", "private_key" : "-----BEGIN PRIVATE KEY-----MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M253Wn9vhdUzojetjv4J+B7kYwsMhRcgdcJ8KCnX1nfzTvI2ksXlTQ2o9BkpStnPetB4s32ZiJRMlk+61iUUMNsHwK2WBX57JT3JgmyVbH8GbmRY0+H3sH1i72luna7rMMD30gLh6QoP3cq7PGWcuZKV7hjd1tjCTQukwMvqV8Icq39buNpIgDOWzEP5AzqXtCOFYn6RTH5SRug4hKNN7sT1eYMslHu7wtEBDKVgrLjOCe/W2f8rLT1zEsoAW2ChlZAPYUBkl/0XuTWRg3CohPPcI+UtlRSfvLDeeQ460swjbwgS/RbJh3sIwlCRLU08kEo04Z9H/AgMBAAECggEAEIeaQqHCWZk/HyYN0Am/GJSGFa2tD60SXY2fUieh8/HlfvCArftGgMaYWPSNCJRMXB7tPwpQu19esjz4Z/cR2Je4fTLPrffGUsHFgZjv5OQBZVe4a5Hj1OcgJYhwCqPs2d9i2wToYNBbcfgh8lSETq8YaXngBO6vES9LMhHkNKKrciu9YkInNEHu6uRJ5g/eGGX3KQynTvVIhnOVGAJvjTXcoU6fm7gYdHAD6jk9lc9MEGpfYI6AdHIwFZcT/RNAxhP82lg2gUJSgAu66FfDjMwQXKbafKdP3zq4Up8a7AlekrguPtfV1vWklg+bUFhgGaiAEYTpAUN9t2DVIiijgQKBgQDnYMMsaF0r557CM1CTXUqgCZo8MKeV2jf2drlxRRwRl33SksQbzAQ/qrLdT7GP3sCGqvkxWY2FPdFYf8kxGcCeZPcIeZYCQAM41pjtsaM8tVbLWVR8UtGBuQoPSph7JNF3Tm/JH/fbwjpjP7dtJ7n8EzkRUNE6aIMHOFEeych/PQKBgQDmf1bMogx63rTcwQ0PEZ9Vt7mTgKYK4aLriWgTWHXPZxUQaYhpjXo6+lMI6DpExiDgBAkMzJGIvS7yQiYWU+wthAr9urbWYdGZlS6VjoTkF6r7VZoILXX0fbuXh6lm8K8IQRfBpJff56p9phMwaBpDNDrfpHB5utBUxs40yIdp6wKBgQC69Cp/xUwTX7GdxQzEJctYiKnBHKcspAg38zJf3bGSXU/jR4eB1lVQhELGI9CbKSdzKM71GyEImix/T7FnJSHIWlho1qVo6AQyduNWnAQD15pr8KAdXGXAZZ1FQcb3KYa+2fflERmazdOTwjYZ0tGqZnXkEeMdSLkmqlCRigWhGQKBgDak/735uP20KKqhNehZpC2dJei7OiIgRhCS/dKASUXHSW4fptBnUxACYocdDxtY4VhafI7FPMdvGl8ioYbvlHFh+X0Xs9r1S8yeWnHoXMb6eXWmYKMJrAoveLa+2cFm1Agf7nLhA4R4lqm9IpV6SKegDUkR4fxp9pPyodZPqBLLAoGBAJkD4wHW54Pwd4Ctfk9ojHjWB7pQlUYpTZO9dm+4fpCMn9Okf43AE2yAOaAP94GdzdDJkxfciXKcsYr9IIukfaoXgjKR7p1zERiWZuFF63SB4aiyX1H7IX0MwHDZQO38a5gZaOm/BUlGKMWXzuEd3fy+1rCUwzOp9LSjtJYf4ege-----END PRIVATE KEY-----", "certificate" : "-----BEGIN CERTIFICATE-----MIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlDb21wYW55IENBMB4XDTE4MDcwMjEzMjU0N1oXDTQ1MTExNzEzMjU0N1owFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0FQGzi3ucTX+DNud1p/b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5U0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8CtlgV+eyU9yYJslWx/Bm5kWNPh97B9Yu9pbp2u6zDA99IC4ekKD93KuzxlnLmSle4Y3dbYwk0LpMDL6lfCHKt/W7jaSIAzlsxD+QM6l7QjhWJ+kUx+UkboOISjTe7E9XmDLJR7u8LRAQylYKy4zgnv1tn/Ky09cxLKAFtgoZWQD2FAZJf9F7k1kYNwqITz3CPlLZUUn7yw3nkOOtLMI28IEv0WyYd7CMJQkS1NPJBKNOGfR/wIDAQABozowODAhBgNVHREEGjAYggpkb21haW4uY29thwQKuUvJhwR/AAABMBMGA1UdJQQMMAoGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAnjiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDaezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZiYsGDVN+9QBd0eYUHce+77s96i3I-----END CERTIFICATE-----", "admin_state_up" : true, "created_at" : "2019-03-31T22:23:51Z", "updated_at" : "2019-03-31T23:26:49Z", "expire_time" : "2045-11-17T13:25:47Z" } ], "page_info" : { "previous_marker" : "5494a835d88f40ff940554992f2f04d4", "current_count" : 3 }, "request_id" : "a27e7ae6-d901-4ec2-8e66-b8a1413819ad" }
  • URI GET /v3/{project_id}/elb/certificates 表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。 description 否 Array 证书的描述。 支持多值查询,查询条件格式:description=xxx&description=xxx。 admin_state_up 否 Boolean 证书的管理状态。 不支持该字段,请勿使用。 domain 否 Array 服务器证书所签域名。该字段仅type为server时有效。 支持多值查询,查询条件格式:domain=xxx&domain=xxx。 type 否 Array 证书的类型。分为服务器证书(server)和CA证书(client)。 支持多值查询,查询条件格式:type=xxx&type=xxx。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 注:自动生成 。 page_info PageInfo object 证书分页信息。 certificates Array of CertificateInfo objects 证书对象列表。 表5 PageInfo 参数 参数类型 描述 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 current_count Integer 当前的记录数。 表6 CertificateInfo 参数 参数类型 描述 admin_state_up Boolean 证书的管理状态。 不支持该字段,请勿使用。 certificate String 证书的内容。PEM编码格式。 description String 证书的描述。 最小长度:1 最大长度:255 domain String 服务器证书所签域名。该字段仅type为server时有效。 总长度为0-10000,由若干普通域名或泛域名组成,域名之间以","分割,不超过100个域名。 普通域名:由若干字符串组成,字符串间以"."分割,单个字符串长度不超过63个字符, 只能包含英文字母、数字或"-",且必须以字母或数字开头和结尾。例:www.test.com。 泛域名:在普通域名的基础上仅允许首字母为""。例:.test.com 最小长度:1 最大长度:10000 id String 证书ID。 name String 证书的名称。 最小长度:1 最大长度:255 private_key String 服务器证书的私钥。PEM编码格式。 当type为client时,该参数被忽略,不影响证书的创建和使用。当type为server时,该字段必须符合格式要求,且私钥必须是有效的。 type String SSL证书的类型。分为服务器证书(server)、CA证书(client)。默认值:server。 created_at String 证书创建时间。 updated_at String 证书更新时间。 expire_time String 证书使用截止时间。 project_id String 证书所在项目ID。
  • 响应示例 响应样例1 { "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200", "max_retries": 3, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] } 响应样例2 { "healthmonitors": [ { "monitor_port": null, "name": "", "admin_state_up": true, "tenant_id": "601240b9c5c94059b63d484c92cfe308", "project_id": "601240b9c5c94059b63d484c92cfe308", "domain_name": null, "delay": 5, "expected_codes": "200", "max_retries": 3, "http_method": "GET", "timeout": 10, "pools": [ { "id": "caef8316-6b65-4676-8293-cf41fb63cc2a" } ], "url_path": "/", "type": "HTTP", "id": "1b587819-d619-49c1-9101-fe72d8b361ef" } ] }
  • 请求示例 请求样例1 全量查询健康检查 GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors 请求样例2 过滤查询类型为HTTP的健康检查 GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/healthmonitors?type=HTTP
  • URI GET /v2/{project_id}/elb/healthmonitors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID,表示上一页最后一条查询记录的健康检查的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的健康检查个数。如果不设置,则默认不分页查询所有。 page_reverse 否 Boolean 分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。 必须与limit一起使用。 id 否 String 健康检查ID。 tenant_id 否 String 健康检查所在的项目ID。 支持的最大字符长度:255 project_id 否 String 此参数和tenant_id参数含义一样,均指健康检查所在的项目ID。 name 否 String 健康检查名称。 支持的最大字符长度:255 delay 否 Integer 健康检查间隔,单位秒,取值范围[1,50]。 max_retries 否 Integer 健康检查连续成功多少次后,将后端服务器的健康检查状态由OFFLINE判定为ONLINE,取值范围[1,10]。 admin_state_up 否 Boolean 健康检查的管理状态。 取值范围:true/false。默认为true; true表示开启健康检查; false表示关闭健康检查。 timeout 否 Integer 健康检查超时时间,单位秒,取值范围[1,50]。 说明: 建议该值小于delay的值。 type 否 String 健康检查的类型。 取值范围:TCP、UDP_CONNECT、HTTP。 monitor_port 否 Integer 健康检查端口号。 默认为空,表示使用后端云服务器的protocol_port作为健康检查的检查端口。 expected_codes 否 String 期望HTTP响应状态码,指定下列值: 单值,例如200; 列表,例如200,202; 区间,例如200-204。 仅当type为HTTP时生效。 支持的最大字符长度:64 说明: 该字段为预留字段,暂未启用。 domain_name 否 String 健康检查时,发送的http请求的域名。 仅当type为HTTP时生效。 默认为空,表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头,只能包含数字、字母、’-’、’.’。 例如:www.test.com 支持的最大字符长度:100 url_path 否 String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如:“/test” 支持的最大字符长度:80 http_method 否 String HTTP请求的方法;默认值:GET 取值范围:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明: 该字段为预留字段,暂未启用。
  • 响应消息 表3 响应参数 参数 参数类型 描述 healthmonitors Array of Healthmonitors objects 健康检查对象列表。列表元素数据结构详见表4。 表4 healthmonitor字段说明 参数 参数类型 描述 id String 健康检查ID。 tenant_id String 健康检查所在的项目ID。 project_id String 此参数和tenant_id参数含义一样,均指健康检查所在的项目ID。 name String 健康检查名称。 delay Integer 健康检查间隔,单位秒,取值范围[1,50]。 max_retries Integer 健康检查最大重试次数,取值范围[1,10]。 pools Array of Pools objects 健康检查关联的后端云服务器组的ID列表。详见表6 admin_state_up Boolean 健康检查的管理状态。 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 timeout Integer 健康检查超时时间,单位秒,取值范围[1,50]。 说明: 建议该值小于delay的值。 type String 健康检查的类型。 取值范围:TCP、UDP_CONNECT、HTTP。 monitor_port Integer 健康检查端口号,取值范围[1,65535]。 默认为空,表示使用后端云服务器的protocol_port作为健康检查的检查端口。 expected_codes String 期望HTTP响应状态码,指定下列值: 单值,例如200; 列表,例如200,202; 区间,例如200-204。 仅当type为HTTP时生效。 暂时不支持该字段,统一置为200。 domain_name String 健康检查时,发送的http请求的域名。 仅当type为HTTP时生效。 默认为空,表示使用负载均衡器的vip_address作为http请求的目的地址。 以数字或字母开头,只能包含数字、字母、’-’、’.’。 例如:www.test.com url_path String 健康检查时发送的http请求路径。默认为“/”。 以“/”开头。 仅当type为HTTP时生效。 例如:“/test” http_method String HTTP请求的方法;默认值:GET 取值范围:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。 仅当type为HTTP时生效。 说明: 该字段为预留字段,暂未启用。 表5 pools字段说明 参数 是否必选 参数类型 描述 id 是 String 后端服务器组id
  • 响应示例 响应样例 { "rule": { "compare_type": "EQUAL_TO", "admin_state_up": true, "provisioning_status": "ACTIVE", "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "/bbb.html", "key": null, "type": "PATH", "id": "c6f457b8-bf6f-45d7-be5c-a3226945b7b1" } }
  • 请求消息 表2 请求参数 参数 是否必选 参数类型 描述 rule 是 Rule object 转发规则对象。详见表3。 表3 rule字段说明 参数 是否必选 参数类型 描述 tenant_id 否 String 转发规则所在的项目ID。 获取方法详见获取项目ID。 需要和token中的project_id一致。 支持的最大字符长度:255 admin_state_up 否 Boolean 转发规则的管理状态; 该字段为预留字段,暂未启用。默认为true。 type 是 String 转发规则的匹配类型。 取值范围: HOST_NAME:匹配请求中的域名; PATH:匹配请求中的路径; 同一个转发策略下转发规则的type不能重复。 compare_type 是 String 转发匹配方式: type为HOST_NAME时,取值范围: EQUAL_TO:精确匹配; type为PATH时,取值范围: REGEX:正则匹配; STARTS_WITH:前缀匹配; EQUAL_TO:精确匹配。 invert 否 Boolean 是否反向匹配; 取值范围:true/false。默认值:false; 该字段为预留字段,暂未启用。 key 否 String 匹配内容的键值。默认为null。 该字段为预留字段,暂未启用。 支持的最大字符长度:255 value 是 String 匹配内容的值。不能包含空格。 支持的最大字符长度:128 当type为HOST_NAME时,取值范围:String (100),字符串只能包含英文字母、数字、“-”或“.”,且必须以字母或数字开头。 当type为PATH时,取值范围:String (128)。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时,字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:| \/()[]{},且必须以"/"开头。
  • 请求示例 请求样例 创建转发规则 POST https://{endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586/rules { "rule": { "compare_type": "EQUAL_TO", "type": "PATH", "value": "/bbb.html" } }
  • 响应消息 表4 响应参数 参数 参数类型 描述 rule Rule object 转发规则对象。详见表5。 表5 rule字段说明 参数 参数类型 描述 id String 转发规则ID tenant_id String 转发规则所在的项目ID。 支持的最大字符长度:255 project_id String 此参数和tenant_id参数含义一样,均指转发规则所在的项目ID。 admin_state_up Boolean 转发规则的管理状态; 该字段为预留字段,暂未启用。取值范围:true/false。 true表示开启。 false表示关闭。 type String 转发规则的匹配类型。 取值范围: HOST_NAME:匹配请求中的域名; PATH:匹配请求中的路径; compare_type String 转发匹配方式: type为HOST_NAME时,取值范围: EQUAL_TO:精确匹配; type为PATH时,取值范围: REGEX:正则匹配; STARTS_WITH:前缀匹配; EQUAL_TO:精确匹配。 invert Boolean 是否反向匹配; 取值范围:true/false。默认值:false; 该字段为预留字段,暂未启用。 key String 匹配内容的键值。默认为null。 该字段为预留字段,暂未启用。 支持的最大字符长度:255 value String 匹配内容的值。 支持的最大字符长度:128 当type为HOST_NAME时,取值范围:String (100),字符串只能包含英文字母、数字、“-”或“.”,且必须以字母或数字开头。 当type为PATH时,取值范围:String (128)。当转发规则的compare_type为STARTS_WITH、EQUAL_TO时,字符串只能包含英文字母、数字、_~';@^-%#&$.*+?,=!:| \/()[]{},且必须以"/"开头。 provisioning_status String 该字段为预留字段,暂未启用。 转发规则的配置状态,可以为ACTIVE。
  • 响应示例 响应样例1 { "l7policies": [ { "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": "" }, { "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 1, "provisioning_status": "ACTIVE", "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", "name": "" } ] } 响应样例2 { "l7policies": [ { "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": "" }, { "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 1, "provisioning_status": "ACTIVE", "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", "name": "" } ] }
  • 请求示例 请求样例1 全量查询转发策略 GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies 请求样例2 过滤查询转发类型为REDIRECT_TO_POOL的转发策略 GET https://{Endpoint}/v2/a31d2bdcf7604c0faaddb058e1e08819/elb/l7policies?action=REDIRECT_TO_POOL
  • 响应消息 表3 响应参数 参数 参数类型 描述 l7policies Array of L7policies objects 转发策略对象列表。列表元素数据结构详见表4 l7policies字段说明。 表4 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。 表5 rules字段说明 参数 参数类型 描述 id String 关联的转发规则id
  • URI GET /v2/{project_id}/elb/l7policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID。 获取方法详见获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始的资源ID,表示上一页最后一条查询记录的转发策略的ID。 必须与limit一起使用。 limit 否 Integer 分页查询每页的转发策略个数。如果不设置,则默认不分页查询所有。 page_reverse 否 Boolean 分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。 必须与limit一起使用。 id 否 String 转发策略ID。 tenant_id 否 String 转发策略所在的项目ID。 支持的最大字符长度:255 获取方法详见获取项目ID。 project_id 否 String 此参数和tenant_id参数含义一样,均指转发策略所在的项目ID。 获取方法详见获取项目ID。 name 否 String 转发策略名称。 支持的最大字符长度:255 admin_state_up 否 Boolean 转发策略的管理状态。 该字段为预留字段,暂未启用。默认为true。 description 否 String 转发策略的描述信息。 支持的最大字符长度:255 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。 该字段为预留字段,暂未启用。 支持的最大字符长度:255 position 否 Integer 转发优先级,从1递增,最高100。默认值:100; 该字段为预留字段,暂未启用。 provisioning_status 否 String 该字段为预留字段,暂未启用。 转发策略的配置状态,可以为ACTIVE。 enterprise_project_id 否 String 企业项目ID,仅用于基于企业项目的细粒度鉴权使用。 如果参数中传递了listerener_id,则用该负载均衡器对应的企业项目ID鉴权。 如果参数中没有传递listerener_id,则使用转发策略对应的企业项目id鉴权。 如果listener_id和enterprise_project_id都没有传递 ,则默认进行细粒度鉴权 ,必须在用户组下分配elb:*list权限才能通过鉴权。
  • 响应参数 状态码: 200 表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
  • 请求示例 更新后端服务器的权重 PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members/1923923e-fe8a-484f-bdbc-e11559b1f48f { "member" : { "name" : "My member", "weight" : 10 } }
  • 响应示例 状态码: 200 操作正常返回。 { "member" : { "name" : "My member", "weight" : 10, "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", "ip_version" : "v4" }, "request_id" : "e7b569d4-15ad-494d-9dd9-8cd740eef8f6" }
  • URI PUT /v3/{project_id}/elb/pools/{pool_id}/members/{member_id} 表1 路径参数 参数 是否必选 参数类型 描述 member_id 是 String 后端服务器ID。 说明: 说明: 此处并非ECS服务器的ID,而是ELB为绑定的后端服务器自动生成的member ID。 pool_id 是 String 后端服务器组ID。 project_id 是 String 项目ID。
  • 示例代码 2中请求体如下: GET https://elb.cn-north-1.myhuaweicloud.com:443/v2/e2e095f1a31c467c89d4251cae136fa1/elb/loadbalancers?limit=2&marker=42aa24dd-32f7-482d-8612-6a4a23320457 2中响应体如下: { "loadbalancers": [ { "id": "84328656-33c6-431b-ac86-e876219e1aa7", "name": "ulb-vg7d", "description": "21212", "provider": "vlb", "listeners": [ { "id": "8bad548d-740f-44db-bc91-c10271a0c750" } ], "pools": [ { "id": "bc632a6f-b691-4f07-8523-2c4c7009d28e" }, { "id": "599a4c5b-c00c-4491-9860-f322200c72a3" } ], "tags": [], "tenant_id": "e2e095f1a31c467c89d4251cae136fa1", "project_id": "e2e095f1a31c467c89d4251cae136fa1", "vip_subnet_id": "0d11891d-92b3-4a89-af39-fad71c6481a7", "vip_port_id": "475890b6-2e31-440b-a2a7-907a71d62c3b", "vip_address": "192.168.40.191", "provisioning_status": "ACTIVE", "operating_status": "ONLINE", "admin_state_up": true, "created_at": "2018-10-11T14:11:19", "updated_at": "2018-11-07T07:38:54", "enterprise_project_id": "0" }, { "id": "992fd704-1e38-4975-a04a-a4e7982146de", "name": "ulb-8yrd", "description": "", "provider": "vlb", "listeners": [ { "id": "ad49e548-1466-43de-9247-10f56e1f2e0e" }, { "id": "bdba3fa8-574f-4c6e-a808-8f21b54b9b1a" } ], "pools": [ { "id": "10977afc-dfb9-40fa-afa5-2177aa8f8529" }, { "id": "18238c04-5b33-4e5c-8069-8728dece4b54" }, { "id": "5389884f-e884-4c98-9e5f-1b8da5cb3fd0" } ], "tags": [], "tenant_id": "e2e095f1a31c467c89d4251cae136fa1", "project_id": "e2e095f1a31c467c89d4251cae136fa1", "vip_subnet_id": "f15e603b-49d3-4b4d-9a26-1f24ea20d443", "vip_port_id": "3421dbcd-5d25-4cb0-b472-e9dfca260bf6", "vip_address": "192.168.0.29", "provisioning_status": "ACTIVE", "operating_status": "ONLINE", "admin_state_up": true, "created_at": "", "updated_at": "", "enterprise_project_id": "0" } ] }
  • 操作步骤 以GET /v2/{project _id}/elb/loadbalancers接口为例,示例帐号下有5个ELB对象,每页查询2个,示范分页查询遍历所有ELB对象的过程。 Postman中设置好头部信息,将获取到的Token放入头部,设置limit为2,查询第一页,如下图。 图1 分页查询-01 判断上一次查询返回实例数是否小于limit个数,如果小于则表示已查询到最后一页,否则需要继续查询下一页。示例中需要查询下一页,设置marker为上一页中最后一个ELB的ID,设置limit为2,查询第二页,如下图。 图2 分页查询-02 同样判断方法,查询第三页,如下图。 图3 分页查询-03 此时上一页查询响应个数小于limit,表示分页查询完成。
  • 响应示例 响应样例 { "rule": { "compare_type": "EQUAL_TO", "admin_state_up": true, "provisioning_status": "ACTIVE", "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "/bbb.html", "key": null, "type": "PATH", "id": "c6f457b8-bf6f-45d7-be5c-a3226945b7b1" } }
共100000条