Help Center/ Cloud Certificate Manager/ API Reference/ Historical APIs/ SCM APIs/ Querying the Certificate List
Updated on 2022-08-09 GMT+08:00
View PDF
Share

Querying the Certificate List

Function

This API is used to query the certificate list based on a certificate name or bound domain name.

This API will be discarded. You are advised to query certificates by referring to Querying the Certificate Lists.

URI

  • URI format

    GET /v2/{project_id}/scm/certlist?order_status=&content=&sort_key=& sort_dir=&limit=&offset=

  • Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID.

Request

Request parameters

Parameter

Mandatory

Type

Description

order_status

No

String

Certificate status. Options:

  • PAID: The certificate has been paid.
  • 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 is being reviewed.
  • CANCELSUPPLEMENTING: The cancellation on additional domain names to be added is being reviewed.

content

No

String

Keyword for search.

sort_key

No

String

Sorting criterion. Options:

  • certExpiredTime: certificate expiration time.
  • certStatus: certificate status.
  • certUpdateTime: certificate update time.

sort_dir

No

String

Sorting method. Sorting is performed based on the sorting parameter sort_key. Options:

  • ASC: ascending order.
  • DESC: descending order.

limit

No

Integer

Maximum number of pieces of certificate information to be displayed on each page. Options:

  • 10: Each page displays up to 10 pieces of certificate information.
  • 20: Each page displays up to 20 pieces of certificate information.
  • 50: Each page displays up to 50 pieces of certificate information.

offset

No

Integer

Offset. Value range: 1-30.

Response

Response parameters

Parameter

Mandatory

Type

Description

total

Yes

Integer

Number of certificates in a list.

free_remain

Yes

Integer

Remaining quota of the free test certificate.

order_list

Yes

Array of order_list objects

Certificate list. For details, see Table 1.
Table 1 order_list

Parameter

Mandatory

Type

Description

cert_id

Yes

String

Certificate ID.

cert_name

Yes

String

Certificate name.

domain

Yes

String

Bound domain name.

cert_type

Yes

String

Certificate type.

cert_brand

Yes

String

Certificate brand.

domain_type

Yes

String

Domain name type.

purchase_period

Yes

Integer

Validity period.

expired_time

Yes

String

Certificate expiration time.

order_status

Yes

String

Certificate status.

domain_num

Yes

Integer

Number of domain names.

wildcard_number

Yes

Integer

Number of wildcard domain names.

cert_des

Yes

String

Certificate description.

Example

  • Example request

    None

  • Example response 
    {  
"total": 1, 
"free_remain":"19", 
"order_list": [{ 
"cert_id": "scs1481110651012", 
"cert_name": "scs-0001", 
"domain": "*.example.com", 
"cert_type": "GE00V01", 
"cert_brand":"GLOBALSIGN",  
"domain_type":" SINGLE_DOMAIN ", 
"purchase_period":1, 
"expired_time":"15051501510501", 
"order_state":"completed ", 
"domain_num":10, 
"wildcard_number":2,
"cert_des":"***********" 
}] 
}
    or 
    { 
   "error_code": "SCM.XXXX",  
   "error_msg": "XXXX"   
 }

Status Codes

Table 2 lists the normal status code returned by the API.
Table 2 Status code

Status Code

Status

Description

200

OK

Request processed successfully.

For details about error code, see Error Codes

Parent topic: SCM APIs