绑定域名证书 - AssociateCertificateV2
功能介绍
如果创建API时，“定义API请求”使用HTTPS请求协议，那么在独立域名中需要添加SSL证书。
本章节主要介绍为特定域名绑定证书。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/apic/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例ID |
|
group_id |
是 |
String |
分组的编号 |
|
domain_id |
是 |
String |
域名的编号 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
证书名称。长度为4 ~ 50位的字符串，字符串由中文、英文字母、数字、下划线组成，且只能以英文或中文开头。 |
|
cert_content |
是 |
String |
证书内容 |
|
private_key |
是 |
String |
证书私钥 |
|
type |
否 |
String |
证书可见范围 |
|
instance_id |
否 |
String |
所属实例ID，当type=instance时必填 |
|
trusted_root_ca |
否 |
String |
信任的根证书CA |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
url_domain |
String |
自定义域名 |
|
id |
String |
自定义域名的编号 |
|
status |
Integer |
CNAME解析状态
|
|
min_ssl_version |
String |
支持的最小SSL版本 |
|
is_http_redirect_to_https |
Boolean |
是否开启http到https的重定向，false为关闭，true为开启，默认为false |
|
verified_client_certificate_enabled |
Boolean |
是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 |
|
ssl_name |
String |
证书的名称 |
|
ssl_id |
String |
证书的编号 |
|
ssl_infos |
Array of SslInfo objects |
SSL证书列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ssl_id |
String |
SSL证书编号 |
|
ssl_name |
String |
SSL证书名称 |
|
algorithm_type |
String |
证书算法类型：
|
|
type |
String |
证书可见范围：
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
为已绑定的域名添加域名证书，证书可见范围为全局可见
{
"name" : "cert_demo",
"private_key" : "-----BEGIN PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END PRIVATE KEY-----",
"cert_content" : "-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----"
}
响应示例
状态码：201
Created
{
"ssl_name" : "cert_demo",
"url_domain" : "www.example.com",
"ssl_id" : "a27be832f2e9441c8127fe48e3b5ac67",
"id" : " f6bb84ccf1c34035878aa51b7253b21c",
"status" : 3
}
状态码：400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
状态码：401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码：403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
状态码：404
Not Found
{
"error_code" : "APIG.3020",
"error_msg" : "The URL domain does not exist"
}
状态码：500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
