更新时间:2023-11-27 GMT+08:00
分享

获取证书详情

功能介绍

查询某张证书的详细信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/scm/certificates/{certificate_id}

表1 路径参数

参数

是否必选

参数类型

描述

certificate_id

String

证书id。

最小长度:16

最大长度:16

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:32

最大长度:2097152

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

证书id。

最小长度:16

最大长度:16

status

String

证书状态。取值如下:

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

  • ISSUED:证书已签发。

  • CHECKING:证书申请审核中。

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

  • UNPASSED:证书申请未通过。

  • EXPIRED:证书已过期。

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

  • REVOKED:证书已吊销。

  • UPLOAD:证书托管中。

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

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

最小长度:0

最大长度:32

order_id

String

订单id。

最小长度:36

最大长度:36

name

String

证书名称。

最小长度:3

最大长度:63

type

String

证书类型。取值如下: DV_SSL_CERT、DV_SSL_CERT_BASIC、EV_SSL_CERT、 EV_SSL_CERT_PRO、OV_SSL_CERT、OV_SSL_CERT_PRO。

最小长度:0

最大长度:32

brand

String

证书品牌。取值如下: GLOBALSIGN、SYMANTEC、GEOTRUST、CFCA。

最小长度:0

最大长度:32

push_support

String

证书是否支持推送。

最小长度:0

最大长度:32

revoke_reason

String

证书吊销原因。

最小长度:0

最大长度:255

signature_algorithm

String

签名算法。

最小长度:0

最大长度:64

issue_time

String

证书签发时间,没有获取到有效值时为空。

最小长度:0

最大长度:32

not_before

String

证书生效时间,没有获取到有效值时为空。

最小长度:0

最大长度:32

not_after

String

证书失效时间,没有获取到有效值时为空。

最小长度:0

最大长度:32

validity_period

Integer

证书有效期,按月为单位。自2020年09月01日起,全球所有CA中心签发的SSL证书的最长有效期为1年。云证书管理服务提供了一种购买多年有效期证书的解决方案,这种多年有效期证书生效方式为多张有效期为1年的SSL证书叠加生效,例如:有效期为“3年”的证书实际包含3张有效期为1年且规格相同的SSL证书,在第一张证书到期前30天,系统自动以第一张证书的信息申请第二张证书,在第二张证书到期前30天,系统自动以第一张证书的信息申请第三张证书。

最小值:12

最大值:12

validation_method

String

域名认证方式,取值如下:DNS、FILE、EMAIL。

最小长度:0

最大长度:32

domain_type

String

域名类型,取值如下:

  • SINGLE_DOMAIN:单域名

  • WILDCARD:通配符

  • MULTI_DOMAIN:多域名

最小长度:0

最大长度:32

domain

String

证书绑定域名。

最小长度:0

最大长度:255

sans

String

证书绑定的附加域名信息。

最小长度:0

最大长度:4096

domain_count

Integer

证书可绑定域名个数。

最小值:1

最大值:100

wildcard_count

Integer

证书可绑定附加域名个数。

最小值:0

最大值:99

fingerprint

String

证书的SHA-1指纹。

最小长度:40

最大长度:40

enterprise_project_id

String

企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。

最小长度:0

最大长度:36

authentification

Array of Authentification objects

域名所有权认证信息,详情请参见Authentification字段数据结构说明。

数组长度:0 - 100

表4 Authentification

参数

参数类型

描述

record_name

String

域名校验值名字。

最小长度:0

最大长度:255

record_type

String

域名校验值类型。

最小长度:0

最大长度:255

record_value

String

域名校验值。

最小长度:0

最大长度:255

domain

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

正常返回。

{
  "id" : "scs1590053258704",
  "order_id" : "CS20052117270N7V9",
  "name" : "scm-testing",
  "type" : "DV_SSL_CERT",
  "brand" : "SYMANTEC",
  "push_support" : "OFF",
  "revoke_reason" : null,
  "status" : "CHECKING_DOMAIN",
  "signature_algorithm" : null,
  "issue_time" : null,
  "not_before" : null,
  "not_after" : null,
  "validity_period" : 12,
  "validation_method" : "DNS",
  "domain_type" : "SINGLE_DOMAIN",
  "domain" : "hosting-******.cloudtest.cn",
  "sans" : null,
  "domain_count" : 1,
  "wildcard_count" : 0,
  "fingerprint" : "185d687de3f44f2249d0e0f084efccb56b7c2cbe",
  "enterprise_project_id" : "0",
  "authentification" : [ {
    "record_name" : "_dnsauth.hosting-****.cloudtest.cn",
    "record_type" : "TXT",
    "record_value" : "201801040000001ytm4q************cd8p7eg9ktlwfsord",
    "domain" : "hosting-*****.cloudtest.cn"
  } ]
}

状态码: 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

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

错误码

请参见错误码

分享:

    相关文档

    相关产品