Updated on 2024-04-25 GMT+08:00

Querying the List of Certificates

Function

This API is used to query the list of certificates.

URI

GET /v1/{project_id}/waf/certificate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

page

No

Integer

Page number of the data to be returned during pagination query. The default value is 1, indicating that the data on the first page is returned.

Default: 1

pagesize

No

Integer

Number of results on each page during pagination query. Value range: 1 to 100. The default value is 10, indicating that each page contains 10 results.

Default: 10

name

No

String

Certificate name

host

No

Boolean

Whether to obtain the domain name for which the certificate is used. The default value is false.

  • true: Obtain the certificates that have been used for domain names.

  • false: Obtain the certificates that have not been used for any domain name.

Default: false

exp_status

No

Integer

Certificate status. The options are as follows: 0: not expired; 1: expired; 2: about to expire (The certificate will expire within one month.)

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

items

Array of CertificateBody objects

Certificates

total

Integer

Total number of certificates

Table 5 CertificateBody

Parameter

Type

Description

id

String

Certificate ID.

name

String

Certificate name

expire_time

Long

Certificate expiration timestamp.

exp_status

Integer

Certificate status. The value can be: 0: The certificate is valid. 1: The certificate has expired. 2: The certificate will expire within one month.

timestamp

Long

Certificate upload timestamp.

bind_host

Array of BindHost objects

Domain name associated with the certificate

Table 6 BindHost

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name

waf_type

String

Deployment mode of WAF instance that is used for the domain name. The value can be cloud for cloud WAF or premium for dedicated WAF instances.

mode

String

This parameter is required only by the dedicated mode.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to query the certificate list in a project. The project ID is specified by project_id.

GET https://{Endpoint}/v1/{project_id}/waf/certificate?enterprise_project_id=0

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "items" : [ {
    "id" : "dc443ca4f29c4f7e8d4adaf485be317b",
    "name" : "demo",
    "timestamp" : 1643181401751,
    "expire_time" : 1650794100000,
    "bind_host" : [ ],
    "exp_status" : 2
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.