查询证书列表
功能介绍
根据证书名称或绑定域名查询证书列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/scm/certificates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页条目数量，取值如下：
最小值：10 最大值：50 缺省值：10 |
|
offset |
否 |
Integer |
偏移量。 最小值：0 最大值：100 缺省值：0 |
|
sort_dir |
否 |
String |
排序方式。根据排序参数sort_key进行排序，取值如下：
缺省值：DESC 最小长度：0 最大长度：32 |
|
sort_key |
否 |
String |
排序依据参数，取值如下：
缺省值：certUpdateTime 最小长度：0 最大长度：64 |
|
status |
否 |
String |
证书状态，取值如下：
缺省值：ALL 最小长度：0 最大长度：64 |
|
enterprise_project_id |
否 |
String |
企业多项目ID。用户未开通企业多项目时，不需要输入该字段。 用户开通企业多项目时，查询资源可以输入该字段。 若用户不输入该字段，默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段，取值满足以下任一条件. 取值为“all” 取值为“0” 满足正则匹配：“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$” 缺省值：all 最小长度：0 最大长度：64 |
|
deploy_support |
否 |
Boolean |
是否仅筛选支持部署的证书。 缺省值：false |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
certificates |
Array of CertificateDetail objects |
证书列表，详情请参见CertificateDetail字段数据结构说明。 数组长度：0 - 1000 |
|
total_count |
Integer |
证书数量。 最小值：0 最大值：10000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
证书id。 最小长度：16 最大长度：16 |
|
name |
String |
证书名称。 最大值：63 最小长度：3 |
|
domain |
String |
证书绑定的域名。 最小长度：1 最大长度：255 |
|
sans |
String |
多域名证书绑定的附加域名。 最小长度：1 最大长度：4096 |
|
signature_algorithm |
String |
签名算法。 最小长度：0 最大长度：64 |
|
deploy_support |
Boolean |
是否支持部署。 |
|
type |
String |
证书类型。取值如下： DV_SSL_CERT、DV_SSL_CERT_BASIC、EV_SSL_CERT、 EV_SSL_CERT_PRO、OV_SSL_CERT、OV_SSL_CERT_PRO 最小长度：1 最大长度：128 |
|
brand |
String |
证书品牌。取值如下：GLOBALSIGN、SYMANTEC、GEOTRUST、CFCA 最小长度：1 最大长度：255 |
|
expire_time |
String |
证书过期时间。 最小长度：1 最大长度：32 |
|
domain_type |
String |
域名类型。取值如下：
最小长度：1 最大长度：128 |
|
validity_period |
Integer |
证书有效期，按月为单位。云证书管理服务提供了一种购买多年有效期证书的解决方案，这种多年有效期证书生效方式为多张有效期为1年的SSL证书叠加生效，例如：有效期为“3年”的证书实际包含3张有效期为1年且规格相同的SSL证书，在第一张证书到期前30天，系统自动以第一张证书的信息申请第二张证书，在第二张证书到期前30天，系统自动以第一张证书的信息申请第三张证书。 最小值：12 最大值：12 |
|
status |
String |
证书状态，取值如下：
最小长度：0 最大长度：64 |
|
domain_count |
Integer |
证书可绑定域名个数。 最小值：1 最大值：100 |
|
wildcard_count |
Integer |
证书可绑定泛域名个数。 最小值：0 最大值：100 |
|
description |
String |
证书描述。 最小长度：0 最大长度：255 |
|
enterprise_project_id |
String |
企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 最小长度：0 最大长度：36 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度：3 最大长度：36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度：0 最大长度：1024 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度：3 最大长度：36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度：0 最大长度：1024 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度：3 最大长度：36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度：0 最大长度：1024 |
请求示例
无
响应示例
状态码： 200
正常返回。
{
"certificates" : [ {
"id" : "scs1554192131150",
"name" : "test",
"domain" : "www.zx.com",
"sans" : "a.zx.com;b.zx.com",
"type" : "OV_SSL_CERT",
"deploy_support" : true,
"signature_algorithm" : "SHA256WITHRSA",
"brand" : "GEOTRUST",
"expire_time" : "2021-05-27 16:46:25.0",
"domain_type" : "MULTI_DOMAIN",
"validity_period" : 12,
"status" : "ISSUED",
"domain_count" : 2,
"wildcard_count" : 0,
"description" : null
} ],
"total_count" : 1
}
状态码： 401
认证失败。
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
状态码： 403
禁止访问。
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
状态码： 500
请求未完成，服务器内部异常。
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回。 |
|
401 |
认证失败。 |
|
403 |
禁止访问。 |
|
404 |
访问页面未找到。 |
|
500 |
请求未完成，服务器内部异常。 |
错误码
请参见错误码。
