接口约束
4.6 负载均衡器
4.7.2 证书列表
状态码
状态码 描述
201 POST操作正常返回。
错误码
● 分页查询使用的参数为marker、limit、page_reverse。
● marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
调试
您可以在API Explorer中调试该接口。
URI
表4-113 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
表4-114 Query 参数
参数 是否必选 参数类型 描述
marker 否 String 上一页最后一条记录的ID。
使用说明:
● 必须与limit一起使用。
● 不指定时表示查询第一页。
● 该字段不允许为空或无效的 ID。
limit 否 Integer 每页返回的个数。
最小值:0 最大值:2000 缺省值:2000
page_reverse 否 Boolean 分页的顺序,true表示从后往前 分页,false表示从前往后分 页,默认为false。
使用说明:
● 必须与limit一起使用。
id 否 Array 证书ID。
支持多值查询,查询条件格式:
id=xxx&id=xxx。
name 否 Array 证书的名称。
支持多值查询,查询条件格式:
name=xxx&name=xxx。 description 否 Array 证书的描述。
支持多值查询,查询条件格式:
description=xxx&description=x xx。
admin_state_
up 否 Boolean 证书的管理状态。
不支持该字段,请勿使用。
domain 否 Array 服务器证书所签域名。该字段仅
type为server时有效。
支持多值查询,查询条件格式:
domain=xxx&domain=xxx。
参数 是否必选 参数类型 描述
type 否 Array 证书的类型。分为服务器证书
(server)和CA证书(client)。
支持多值查询,查询条件格式:
type=xxx&type=xxx。
请求参数
表4-115 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String IAM鉴权Token。
响应参数
状态码: 200
表4-116 响应 Body 参数
参数 参数类型 描述
request_id String 请求ID。
注:自动生成 。 page_info PageInfo
object 证书分页信息。
certificates Array of CertificateInf o objects
证书对象列表。
表4-117 PageInfo
参数 参数类型 描述
previous_mar
ker String 分页查询结果中第一条记录的ID next_marker String 分页查询结果中最后一条记录的ID。
current_count Integer 当前的记录数。
表4-118 CertificateInfo
参数 参数类型 描述
admin_state_
up Boolean 证书的管理状态。
不支持该字段,请勿使用。
certificate String 证书的内容。PEM编码格式。
description String 证书的描述。
最小长度:1 最大长度:255
domain String 服务器证书所签域名。该字段仅type为server时 有效。 总长度为0-1024,由若干普通域名或泛域 名组成,域名之间以","分割,不超过30个域名。
普通域名:由若干字符串组成,字符串间以"."分 割,单个字符串长度不超过63个字符,只能包含 英文字母、数字或"-",且必须以字母或数字开头 和结尾。例:www.test.com; 泛域名:在普通 域名的基础上仅允许首字母为""。例:.test.com 最小长度:1
最大长度:1024
id String 证书ID。
name String 证书的名称。
最小长度:1 最大长度:255
private_key String 服务器证书的私钥。PEM编码格式。 当type为 client时,该参数被忽略,不影响证书的创建和使 用。且若不符合格式,不报错但会被设置为空。
当type为server时,该字段必须符合格式要求,
且私钥必须是有效的。
type String 证书的类型。分为服务器证书(server)和CA证书 (client)。默认值:server。
created_at String 证书创建时间。
updated_at String 证书更新时间。
expire_time String 证书使用截止时间。
project_id String 证书所在项目ID。
enc_certificate String HTTPS协议使用的SM加密证书内容。
取值:PEM编码格式。
注意:仅在当前局点的SM加密证书特性开启才会 返回该字段。
参数 参数类型 描述 enc_private_k
ey String HTTPS协议使用的SM加密证书私钥。
取值:PEM编码格式。
注意:仅在当前局点的SM加密证书特性开启才会 返回该字段。
请求示例
GET https://{ELB_Endpoint}/v3/{project_id}/elb/certificates
响应示例
状态码: 200 操作正常返回。
{ "certificates" : [ {
"id" : "5494a835d88f40ff940554992f2f04d4", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "name" : "https_certificatekkkk",
"type" : "server", "domain" : null,
"description" : "description for certificatehhhh", "private_key" : "---BEGIN PRIVATE
KEY---\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M +1rCUwzOp9LSjtJYf4ege\n---END PRIVATE KEY---",
"certificate" : "---BEGIN
CERTIFICATE---\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD
\nA4IBAQA8lMQJxaTey7EjXtRLSVlEAMftAQPG6jijNQuvIBQYUDauDT4W2XUZ5wAn
\njiOyQ83va672K1G9s8n6xlH+xwwdSNnozaKzC87vwSeZKIOdl9I5I98TGKI6OoDa
\nezmzCwQYtHBMVQ4c7Ml8554Ft1mWSt4dMAK2rzNYjvPRLYlzp1HMnI6hkjPk4PCZ
\nwKnha0dlScati9CCt3UzXSNJOSLalKdHErH08Iqd+1BchScxCfk0xNITn1HZZGmI\n
+vbmunok3A2lucI14rnsrcbkGYqxGikySN6B2cRLBDK4Y3wChiW6NVYtVqcx5/mZ\niYsGDVN+9QBd0eYUHce +77s96i3I\n---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---\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M +1rCUwzOp9LSjtJYf4ege\n---END PRIVATE KEY---",
"certificate" : "---BEGIN
CERTIFICATE---\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD +77s96i3I\n---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---\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M +1rCUwzOp9LSjtJYf4ege\n---END PRIVATE KEY---",
"certificate" : "---BEGIN
CERTIFICATE---\nMIIC4TCCAcmgAwIBAgICEREwDQYJKoZIhvcNAQELBQAwFzEVMBMGA1UEAxMMTXlD +77s96i3I\n---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"
}
状态码
状态码 描述
200 操作正常返回。
错误码
请参见错误码。