功能介绍
购买SSL证书。
说明
请求参数“agree_privacy_protection”必须设置为“true”，才能成功提交购买证书申请。
URI
● URI格式
POST /v2/{project_id}/scm/cert/purchase
● 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
请求消息
请求参数
参数 是否必选 参数类型 描述
cert_brand 是 String 证书品牌。
如：GLOBALSIGN
参数 是否必选 参数类型 描述
cert_type 是 String 证书类型，取值如下：
● OV_SSL_CERT：企业型SSL 证书。
● EV_SSL_CERT：增强型SSL证 书。
domain_type 是 String 域名类型，取值如下：
● SINGLE_DOMAIN：单域名 类型。
● MULTI_DOMAIN：多域名类 型。
● WILDCARD：泛域名类型。
effective_time 是 Integer 证书有效期（年），取值如下：
● 1：购买有效期为1年的证
● 当“domain_type”选择的 是“SINGLE_DOMAIN”或
“WILDCARD”类型的证书 时，域名数量取值为“1”。
● 当“domain_type”选择的 是“MULTI_DOMAIN”类型 的证书时，域名数量取值范 围为“2~100”。
order_number 是 Integer 购买的证书数量。取值范围为 1~1000。
agree_privacy
_protection 是 Boolean 是否同意隐私协议。
● true：同意隐私协议。
order_id 是 String 订单号。
参数 是否必选 参数类型 描述 cert 是 Array of cert
objects 证书列表，详情请参见表6-1。
表6-1 cert
参数 是否必选 参数类型 描述
cert_id 是 String 证书ID。
示例
如下以购买1张品牌为Globalsign，域名类型为多域名，域名数量为5，有效期为1年的 OV证书为例。
● 请求样例
{ "cert_brand":"GLOBALSIGN", "cert_type":"OV_SSL_CERT ", "domain_type":"MULTI_DOMAIN", "effective_time": 1,
"domain_numbers": 5, "order_number": 1,
"agree_privacy_protection":true, }
● 响应样例
{ "order_id": "CS1803192259ROA8U"
"cert": [{
"cert_id": "scs1481110651012", }]
}
或
{ "error_code": "SCM.XXXX", "error_msg": "XXXX"
}
状态码
表6-2描述的是API返回的正常状态码。
表6-2 状态码
状态码 编码 状态说明
200 OK 请求已成功。
异常状态码，请参见错误码。
6.2 查询证书列表
功能介绍
根据证书名称或绑定域名查询证书列表。
须知
当前页面API即将废弃，建议您使用查询证书列表。
URI
● URI格式
GET /v2/{project_id}/scm/certlist?order_status=&content=&sort_key=&
sort_dir=&limit=&offset=
● 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
请求消息
请求参数
参数 是否必选 参数类型 描述
order_status 否 String 证书状态，取值如下：
● PAID：证书已支付；待申请 证书。
● ISSUED：证书已签发。
● CHECKING：证书申请审核 中。
● CANCELCHECKING：取消证 书申请审核中。
● UNPASSED：证书申请未通 过。
● EXPIRED：证书已过期。
● REVOKING：证书吊销申请 审核中。
● REVOKED：证书已吊销。
● UPLOAD：证书托管中。
● SUPPLEMENTCHECKING：
多域名证书新增附加域名审 核中。
● CANCELSUPPLEMENTING：
取消新增附加域名审核中。
content 否 String 搜索关键词。
sort_key 否 String 排序依据参数，取值如下：
● certExpiredTime：证书到期 时间。
● certStatus：证书状态。
● certUpdateTime：证书更新 时间。
sort_dir 否 String 排序方式。根据排序参数
sort_key进行排序，取值如下：
● ASC：升序。
● DESC：降序。
limit 否 Integer 每页条目数量，取值如下：
● 10：每页显示10条证书信
offset 否 Integer 偏移量。取值范围为1~30。
响应消息
响应参数
参数 是否必选 参数类型 描述
total 是 Integer 列表证书数量。
free_remain 是 Integer 免费测试证书剩余配额。
order_list 是 Array of order_list objects
证书列表，详情请参见表6-3。
表6-3 order_list
参数 是否必选 参数类型 描述
cert_id 是 String 证书ID。
cert_name 是 String 证书名称。
domain 是 String 绑定域名。
cert_type 是 String 证书类型。
cert_brand 是 String 证书品牌。
domain_type 是 String 域名类型。
purchase_peri
od 是 Integer 有效期。
expired_time 是 String 证书到期时间。
order_status 是 String 证书状态。
domain_num 是 Integer 域名数量。
wildcard_num
ber 是 Integer 泛域名数量。
cert_des 是 String 证书描述。
示例
● 请求样例 无。
● 响应样例
{ "total": 1,
"free_remain":"19",
"order_list": [{
"cert_id": "scs1481110651012",
"cert_name": "scs-0001",
"domain": "*.example.com",
"cert_type": "GE00V01",
"cert_brand":"GLOBALSIGN",
"domain_type":" SINGLE_DOMAIN ",
"purchase_period":1,
"expired_time":"15051501510501",
"order_state":"completed ",
"domain_num":10,
"wildcard_number":2,
"cert_des":"***********"
}] }
或{
"error_code": "SCM.XXXX", "error_msg": "XXXX"
}
状态码
表6-4描述的是API返回的正常状态码。
表6-4 状态码
状态码 编码 状态说明
200 OK 请求已成功。
异常状态码，请参见错误码。