Help Center> SSL Certificate Manager> API Reference> API Description> Obtaining Details of a Certificate
View PDF

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. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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 hosted.

  • 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

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, or OV_SSL_CERT_PRO

Minimum: 0

Maximum: 32

brand

String

Certificate authority. The value can be: 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_algrithm

String

Signature algorithm.

Minimum: 0

Maximum: 64

issue_time

String

Certificate issuance time. 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.

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 type. The value can be:

  • SINGLE_DOMAIN: single domain names

  • WILDCARD: wildcard domains

  • MULTI_DOMAIN: multiple domain names

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

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

Domain verification value.

Minimum: 0

Maximum: 255

domain

String

Domain name mapping to the verification value

Minimum: 0

Maximum: 255

Status code: 401

Table 5 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 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: 500

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

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_algrithm" : null,
  "issue_time" : null,
  "not_before" : null,
  "not_after" : null,
  "validity_period" : 12,
  "validation_method" : "DNS",
  "domain_type" : "SINGLE_DOMAIN",
  "domain" : "hosting-******.hwcloudtest.cn",
  "sans" : null,
  "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

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.

Error Codes

See Error Codes.

Parent topic: API Description