接口约束
4.6 负载均衡器
4.7.4 更新证书
状态码
状态码 描述
200 操作正常返回。
错误码
请参见错误码。
4.7.4 更新证书
功能介绍
更新证书。
接口约束
如果待更新证书的域名不为空,且被监听器使用;则不允许更新该证书的域名为空,
否则系统会返回409响应。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v3/{project_id}/elb/certificates/{certificate_id}
表4-123 路径参数
参数 是否必选 参数类型 描述
certificate_id 是 String 证书ID。
project_id 是 String 证书所在项目ID。
请求参数
表4-124 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String IAM鉴权Token。
表4-125 请求 Body 参数
参数 是否必选 参数类型 描述
certificate 是 UpdateCertifi cateOption object
证书对象。
表4-126 UpdateCertificateOption
参数 是否必选 参数类型 描述
certificate 否 String 证书的内容。PEM编码格式。
description 否 String 证书的描述。
最小长度:0 最大长度:255
name 否 String 证书的名称。
最小长度:0 最大长度:255
private_key 否 String 服务器证书的私钥。PEM编码格 式。
当type为client时,该参数被忽 略,不影响证书的创建和使用。
且若不符合格式,不报错但会被 设置为空。
当type为server时,该字段必须 符合格式要求,且私钥必须是有 效的。
参数 是否必选 参数类型 描述
domain 否 String 服务器证书所签域名。该字段仅
type为server时有效。 总长度为 0-1024,由若干普通域名或泛 域名组成,域名之间以","分 割,不超过30个域名。 普通域 名:由若干字符串组成,字符串 间以"."分割,单个字符串长度 不超过63个字符,只能包含英 文字母、数字或"-",且必须以 字母或数字开头和结尾。例:
www.test.com; 泛域名:在普 通域名的基础上仅允许首字母 为""。例:.test.com
最小长度:0 最大长度:1024
enc_certificate 否 String HTTPS协议使用的SM加密证书 内容。
取值:PEM编码格式。
使用说明:
● 仅type为server_sm时有效。
enc_private_k
ey 否 String HTTPS协议使用的SM加密证书
内容。
取值:PEM编码格式。
使用说明:
● 仅type为server_sm时有效。
响应参数
状态码: 200
表4-127 响应 Body 参数
参数 参数类型 描述
request_id String 请求ID。
注:自动生成 。 certificate CertificateInf
o object 证书对象。
表4-128 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加密证书特性开启才会 返回该字段。
请求示例
PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/certificates/
233a325e5e3e4ce8beeb320aa714cc12 { "certificate" : {
"name" : "My Certificate",
"description" : "Update my Certificate."
}}
响应示例
状态码: 200 操作正常返回。
{ "certificate" : {
"private_key" : "---BEGIN PRIVATE
KEY---\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDQVAbOLe5xNf4M +1rCUwzOp9LSjtJYf4ege\n---END PRIVATE KEY---",
"description" : "Update my Certificate.", "domain" : null,
"created_at" : "2019-03-31T22:23:51Z", "expire_time" : "2045-11-17T13:25:47Z", "id" : "233a325e5e3e4ce8beeb320aa714cc12", "name" : "My Certificate",
"certificate" : "---BEGIN
CERTIFICATE---\nA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\n0FQGzi3ucTX +DNud1p/
b4XVM6I3rY7+Cfge5GMLDIUXIHXCfCgp19Z3807yNpLF5\nU0NqPQZKUrZz3rQeLN9mYiUTJZPutYlFDDbB8Ctl gV+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---",
"admin_state_up" : true,
"project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "updated_at" : "2019-03-31T23:26:49Z",
"type" : "server"
}, "request_id" : "d9abea6b-98ee-4ad4-8c5d-185ded48742f"
}
状态码
状态码 描述
200 操作正常返回。
错误码
请参见错误码。