Obtaining Details of a Certificate

Updated on 2023-01-13 GMT+08:00

View PDF

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. The token can be obtained by calling the token API of IAM. 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 value can be: 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: 36 Maximum: 36
name	String	SSL certificate name Minimum: 0 Maximum: 255
type	String	Certificate type. The value can be: DV_SSL_CERT DV_SSL_CERT_BASIC EV_SSL_CERT EV_SSL_CERT_PRO OV_SSL_CERT OV_SSL_CERT_PRO Minimum: 0 Maximum: 32
brand	String	Certificate authority. The value can be: GLOBALSIGN SYMANTEC GEOTRUST CFCA Minimum: 0 Maximum: 32
push_support	String	Whether the certificate can be pushed to other services. 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 took effect. If no valid value is obtained, this parameter is left blank. Minimum: 0 Maximum: 32
not_after	String	Time when the certificate expired. If no valid value is obtained, this parameter is left blank. Minimum: 0 Maximum: 32
validity_period	Integer	Certificate validity period, in months. Minimum: 12 Maximum: 12
validation_method	String	Domain name ownership verification method. The value can be: DNS FILE 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
domain	String	Domain name associated with the 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 associated with the certificate. Minimum: 1 Maximum: 100
wildcard_count	Integer	Number of additional domain names can be associated with the certificate. Minimum: 0 Maximum: 99
authentification	Array of Authentification objects	Domain ownership verification information. For details, see data structure of the Authentification field.

**Table 4** 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	Type of the domain name verification value. Minimum: 0 Maximum: 255
domain	String	Domain name mapping to the verification record. Minimum: 0 Maximum: 255

Status code: 401

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

Status code: 403

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

Status code: 500

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

Example Requests

None

Example Responses

Status code: 200

Normal response.

{
  "id" : "scs1590053258704",
  "order_id" : "CS20052117270N7V9",
  "name" : "scm-testing",
  "type" : "DV_SSL_CERT",
  "brand" : "SYMANTEC",
  "push_support" : "OFF",
  "status" : "CHECKING_DOMAIN",
  "validity_period" : 12,
  "validation_method" : "DNS",
  "domain_type" : "SINGLE_DOMAIN",
  "domain" : "hosting-******.hwcloudtest.cn",
  "domain_count" : 1,
  "wildcard_count" : 0,
  "authentification" : [ {
    "record_name" : "_dnsauth.hosting-****.hwcloudtest.cn",
    "record_type" : "TXT",
    "record_value" : "201801040000001ytm4q************cd8p7eg9ktlwfsord",
    "domain" : "hosting-*****.hwcloudtest.cn"
  } ]
}

Status code: 401

Verification 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 respond the request due to an internal server error.

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

Status Codes

Status Code	Description
200	Normal response.
401	Verification failed.
403	Access denied.
404	Requested page not found.
500	Failed to respond the request due to an internal server error.