Querying the Certificate List

Function

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

URI

GET /v3/scm/certificates

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of certificate records on each page. The options are as follows: 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	Query offset. Minimum: 0 Maximum: 100 Default: 0
sort_dir	No	String	Sorting order. The returned certificates are listed by parameter sort_key. The options are as follows: ASC: ascending order DESC: descending order Default: DESC Minimum: 0 Maximum: 32
sort_key	No	String	Sorting criteria. The options are as follows: 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. EXPIRED: The certificate has expired. UPLOAD: The certificate is being managed. Default: ALL Minimum: 0 Maximum: 64
deploy_support	No	Boolean	Whether to filter only certificates that can be deployed. Default: false
expired_days_since	No	Integer	The certificate is within the validity period or expires in a maximum of xx days. Minimum: 0 Maximum: 1095 Default: 0

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
certificates	Array of CertificateDetail objects	For details, see data structure description of the CertificateDetail field. Array Length: 0 - 1000
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. Maximum: 63 Minimum: 3
domain	String	Domain name bound to a certificate. Minimum: 1 Maximum: 255
sans	String	Additional domain name bound to a multi-domain certificate. Minimum: 1 Maximum: 4096
signature_algorithm	String	Signature algorithm. Minimum: 0 Maximum: 64
deploy_support	Boolean	Whether deployment is supported.
type	String	Certificate type. Minimum: 1 Maximum: 128
brand	String	Certificate authority. Minimum: 1 Maximum: 255
expire_time	String	Certificate expiration time. Minimum: 1 Maximum: 32
domain_type	String	Zone type. 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: EXPIRED: The certificate has expired. UPLOAD: The certificate is being managed. Minimum: 0 Maximum: 64
domain_count	Integer	Number of domain names can be bound to a certificate. Minimum: 1 Maximum: 100
wildcard_count	Integer	Number of wildcard domain names can be bound to a certificate. Minimum: 0 Maximum: 100
description	String	Certificate description Minimum: 0 Maximum: 255
domain_id	String	Account ID. Minimum: 0 Maximum: 100

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.

{
  "certificates" : [ {
    "id" : "scs1554192131150",
    "name" : "test",
    "domain" : "www.zx.com",
    "sans" : "a.zx.com;b.zx.com",
    "type" : null,
    "deploy_support" : true,
    "signature_algorithm" : "SHA256WITHRSA",
    "brand" : null,
    "expire_time" : "2021-05-27 16:46:25.0",
    "domain_type" : null,
    "validity_period" : 12,
    "status" : "UPLOAD",
    "domain_count" : 2,
    "wildcard_count" : 0,
    "description" : null
  } ],
  "total_count" : 1
}

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.