更新时间:2022-03-29 GMT+08:00
分享

查询证书列表

功能介绍

根据证书名称或绑定域名查询证书列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/scm/certificates

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页条目数量,取值如下:

  • 10:每页显示10条证书信息。

  • 20:每页显示20条证书信息。

  • 50:每页显示50条证书信息。

最小值:10

最大值:50

缺省值:10

offset

Integer

偏移量。取值范围为1~30。

最小值:0

最大值:30

缺省值:0

sort_dir

String

排序方式。根据排序参数sort_key进行排序,取值如下:

  • ASC:升序。

  • DESC:降序。

缺省值:DESC

最小长度:0

最大长度:32

sort_key

String

排序依据参数,取值如下:

  • certExpiredTime:证书到期时间。

  • certStatus:证书状态。

  • certUpdateTime:证书更新时间。

缺省值:certUpdateTime

最小长度:0

最大长度:64

status

String

证书状态,取值如下:

  • ALL:所有证书状态。

  • PAID:证书已支付,待申请证书。

  • ISSUED:证书已签发。

  • CHECKING:证书申请审核中。

  • CANCELCHECKING:取消证书申请审核中。

  • UNPASSED:证书申请未通过。

  • EXPIRED:证书已过期。

  • REVOKING:证书吊销申请审核中。

  • REVOKED:证书已吊销。

  • UPLOAD:证书托管中。

  • CHECKING_ORG:待完成企业资格认证。

  • ISSUING:证书待签发。

  • SUPPLEMENTCHECKING:多域名证书新增附加域名审核中。

缺省值:ALL

最小长度:0

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:32

最大长度:2097152

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

certificates

Array of CertificateDetail objects

证书列表,详情请参见CertificateDetail字段数据结构说明。

total_count

Integer

证书数量。

最小值:0

最大值:10000

表4 CertificateDetail

参数

参数类型

描述

id

String

证书id。

最小长度:16

最大长度:16

name

String

证书名称。

最大值:255

最小长度:1

正则匹配:^[a-z0-9-]+$

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

域名类型。取值如下:

  • SINGLE_DOMAIN:单域名

  • WILDCARD:通配符

  • MULTI_DOMAIN:多域名

最小长度:1

最大长度:128

validity_period

Integer

证书有效期,以月为单位。

最小值:12

最大值:12

status

String

证书状态,取值如下:

  • PAID:证书已支付;待申请证书。

  • ISSUED:证书已签发。

  • CHECKING:证书申请审核中。

  • CANCELCHECKING:取消证书申请审核中。

  • UNPASSED:证书申请未通过。

  • EXPIRED:证书已过期。

  • REVOKING:证书吊销申请审核中。

  • CANCLEREVOKING:证书取消吊销申请审核中。

  • REVOKED:证书已吊销。

  • UPLOAD:证书托管中。

  • SUPPLEMENTCHECKING:多域名证书新增附加域名审核中。

  • CANCELSUPPLEMENTING:取消新增附加域名审核中。

最小长度:0

最大长度:64

domain_count

Integer

证书可绑定域名个数。

最小值:1

最大值:100

wildcard_count

Integer

证书可绑定泛域名个数。

最小值:0

最大值:100

description

String

证书描述。

最小长度:0

最大长度:255

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 500

表7 响应Body参数

参数

参数类型

描述

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

请求未完成,服务器内部异常。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读