Obtaining Details of a Certificate

Function

This API is used to query details about a certificate.

URI

GET /v3/scm/certificates/{certificate_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
certificate_id	Yes	String	Certificate ID. Minimum: 16 Maximum: 16

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Certificate ID. Minimum: 16 Maximum: 16
status	String	Certificate status. The options are: PAID: The certificate has been paid and needs to be applied for from the CA. ISSUED: The certificate has been issued. CHECKING: The certificate application is being reviewed. CANCELCHECKING: The certificate application cancellation is being reviewed. UNPASSED: The certificate application fails. EXPIRED: The certificate has expired. REVOKING: The certificate revocation application is being reviewed. REVOKED: The certificate has been revoked. UPLOAD: The certificate is being managed. SUPPLEMENTCHECKING: Additional domain names to be added for a multi-domain certificate are being reviewed. CANCELSUPPLEMENTING: The cancellation on additional domain names to be added is being reviewed. Minimum: 0 Maximum: 32
order_id	String	Order ID. Minimum: 0 Maximum: 63
name	String	Certificate name. Minimum: 3 Maximum: 63
type	String	Certificate type. The options are: DV_SSL_CERT, DV_SSL_CERT_BASIC, EV_SSL_CERT, EV_SSL_CERT_PRO, OV_SSL_CERT, or OV_SSL_CERT_PRO Minimum: 0 Maximum: 32
brand	String	Certificate authority. The options are: GLOBALSIGN, SYMANTEC, GEOTRUST, or CFCA Minimum: 0 Maximum: 32
push_support	String	Whether a certificate can be pushed. Minimum: 0 Maximum: 32
revoke_reason	String	Reason for certificate revocation. Minimum: 0 Maximum: 255
signature_algorithm	String	Signature algorithm. Minimum: 0 Maximum: 64
issue_time	String	Time when the certificate was issued. If no valid value is obtained, this parameter is left blank. Minimum: 0 Maximum: 32
not_before	String	Time when the certificate takes effect. If no valid value is obtained, this parameter is left blank. Minimum: 0 Maximum: 32
not_after	String	Time when the certificate becomes invalid. If no valid value is obtained, this parameter is left blank. Minimum: 0 Maximum: 32
validity_period	Integer	Certificate validity period, in months. [CCM provides a solution for purchasing certificates with a multi-year validity period. This multi-year certificate takes effect by adding multiple SSL certificates with a validity period of one year. For example, a certificate with three years' validity period contains three SSL certificates with one-year validity period and the same specifications. The system automatically applies for a second certificate based on the information about the first certificate 30 days before the first certificate expires.] (tag:hws) Minimum: 12 Maximum: 12
validation_method	String	Domain ownership verification method. The value can be DNS, FILE, or EMAIL. Minimum: 0 Maximum: 32
domain_type	String	Domain name type. The options are as follows: SINGLE_DOMAIN: Single domain names WILDCARD: Wildcard domain names MULTI_DOMAIN: Multiple domain names Minimum: 0 Maximum: 32
multi_domain_type	String	Multi-domain name type. The options are as follows: primary_single: primary single domain name primary_wildcard: primary wildcard domain name Minimum: 0 Maximum: 32
domain	String	Domain name bound to a certificate. Minimum: 0 Maximum: 255
sans	String	Additional domain name associated with the certificate Minimum: 0 Maximum: 4096
domain_count	Integer	Number of domain names can be bound to a certificate. Minimum: 1 Maximum: 100
wildcard_count	Integer	Number of additional domain names can be bound to a certificate. Minimum: 0 Maximum: 99
fingerprint	String	SHA-1 certificate fingerprint Minimum: 40 Maximum: 40
shared	Boolean	Shared resource or not
application_info	application_info object	Certificate application information.
description	String	Certificate description. Minimum: 0 Maximum: 255
authentification	Array of Authentification objects	Domain ownership verification information. For details, see data structure of the Authentification field. Array Length: 0 - 100

**Table 4** application_info
Parameter	Type	Description
country	String	Country or region. Minimum: 0 Maximum: 255
company_name	String	Company name. Minimum: 0 Maximum: 255
company_province	String	State/Province Minimum: 0 Maximum: 255
company_city	String	City where a company is located. Minimum: 0 Maximum: 255
applicant_name	String	Applicant name. Minimum: 0 Maximum: 255
applicant_phone	String	Phone number of an applicant. Minimum: 0 Maximum: 255
applicant_email	String	Email of an applicant. Minimum: 0 Maximum: 255
contact_name	String	Name of a technical contact. Minimum: 0 Maximum: 255
contact_phone	String	Phone number of the technical contact. Minimum: 0 Maximum: 255
contact_email	String	Email of a technical contact. Minimum: 0 Maximum: 255

**Table 5** Authentification
Parameter	Type	Description
record_name	String	Name of a domain ownership verification value. Minimum: 0 Maximum: 255
record_type	String	Type of the domain name verification value. Minimum: 0 Maximum: 255
record_value	String	Domain verification value. Minimum: 0 Maximum: 255
domain	String	Domain name mapping to the verification value Minimum: 0 Maximum: 255

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Example Requests

None

Example Responses

Status code: 200

Normal return.

{
  "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",
  "multi_domain_type" : null,
  "domain" : "hosting-******.test.cn",
  "sans" : null,
  "domain_count" : 1,
  "wildcard_count" : 0,
  "fingerprint" : "185d687de3f44f2249d0e0f084efccb56b7c2cbe",
  "enterprise_project_id" : "0",
  "authentification" : [ {
    "record_name" : "_dnsauth.hosting-****.test.cn",
    "record_type" : "TXT",
    "record_value" : "201801040000001ytm4q************cd8p7eg9ktlwfsord",
    "domain" : "hosting-*****.test.cn"
  } ]
}

Status code: 401

Authentication failed.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 403

Access denied.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 500

Failed to complete the request because of an internal server error.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code	Description
200	Normal return.
401	Authentication failed.
403	Access denied.
404	Access page not found.
500	Failed to complete the request because of an internal server error.