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

Querying the Certificate List

Function

This API is used to query the certificate list by certificate name or associated domain name.

URI

GET /v3/scm/certificates

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of certificate records displayed on each page. The values can be: - 10: 10 certificate records can be displayed on each page. - 20: 20 certificate records can be displayed on each page. - 50: 50 certificate records can be displayed on each page.

Minimum: 10

Maximum: 50

Default: 10

offset

No

Integer

Offset.

Minimum: 0

Default: 0

sort_dir

No

String

Sorting method. Sorting is performed based on the sorting parameter sort_key. The value can be: - ASC: Ascending order - DESC: descending order.

Default: DESC

Minimum: 0

Maximum: 32

sort_key

No

String

Parameter by which the certificates are sorted out. The value can be: - certExpiredTime: certificate expiration time. - certStatus: certificate status. - certUpdateTime: certificate update time.

Default: certUpdateTime

Minimum: 0

Maximum: 64

status

No

String

Certificate status. The options are as follows:

  • ALL: All certificate statuses.

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

  • CHECKING_ORG: The organization verification is to be completed.

  • ISSUING: The certificate is to be issued.

  • SUPPLEMENTCHECKING: Additional domain names to be added for a multi-domain certificate are being reviewed.

Default: ALL

Minimum: 0

Maximum: 64

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

certificates

Array of CertificateDetail objects

Certificate list. For details, see Data structure of the CertificateDetail field.

total_count

Integer

Number of certificates.

Minimum: 0

Maximum: 10000

Table 4 CertificateDetail

Parameter

Type

Description

id

String

Certificate ID

Minimum: 16

Maximum: 16

name

String

Certificate name

Minimum: 1

domain

String

Domain name associated with the certificate.

Minimum: 1

Maximum: 255

sans

String

Additional domain name associated with the certificate

Minimum: 1

Maximum: 4096

signature_algorithm

String

Signature algorithm.

Minimum: 0

Maximum: 64

deploy_support

Boolean

Whether the certificate can be deployed to other services.

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: 1

Maximum: 128

brand

String

Certificate authority. The value can be: GLOBALSIGN SYMANTEC GEOTRUST CFCA.

Minimum: 1

Maximum: 255

expire_time

String

Certificate expiration time.

Minimum: 1

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: 1

Maximum: 128

validity_period

Integer

Certificate validity period, in months.

Minimum: 12

Maximum: 12

status

String

Certificate status. The options are as follows:

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

  • CANCLEREVOKING: The cancellation on certificate revocation 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: 64

domain_count

Integer

Number of domain names that can be associated with the certificate.

Minimum: 1

Maximum: 100

wildcard_count

Integer

Number of wildcard domain names that can be associated with the certificate.

Minimum: 0

Maximum: 100

description

String

Certificate description.

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.

{
  "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
  } ],
  "total_count" : 1
}

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.

Error Codes

See Error Codes.