All Products
Search
Document Center

Edge Security Acceleration:ListClientCaCertificates

Last Updated:Nov 07, 2025

Queries a list of client certificate authority (CA) certificates for a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListClientCaCertificateslist
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

The website ID, which can be obtained by calling the ListSites operation.

1234567890123
PageNumberlongNo

The page number. Valid values: 1 to 500.

1
PageSizelongNo

The number of entries per page. Default value: 20. Valid values: 1 to 100.

20

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

F61CDR30-E83C-4FDA-BF73-9A94CDD44229
TotalCountlong

The total number of entries.

16
PageNumberlong

The page number.

1
PageSizelong

The number of entries per page.

20
SiteIdlong

The website ID.

1234567890123
SiteNamestring

The website name.

example.com
Resultarray<object>

The queried client CA certificates.

CertItemobject

The certificate information.

Idstring

The certificate ID.

babab9db65ee5efcca9f3d41d4b5****
Namestring

The certificate name.

yourCertName
Statusstring

The certificate status.

OK
Typestring

The certificate type.

upload
CommonNamestring

The Common Name of the certificate.

www.example.com
NotBeforestring

The time when the certificate takes effect.

2023-03-31 02:08:00
NotAfterstring

The time when the certificate expires.

2024-03-31 02:08:00
Issuerstring

The CA that issued the certificate.

GlobalSign nv-sa
SANstring

The Subject Alternative Name (SAN) of the certificate.

www.example.com,*.example.com
SignatureAlgorithmstring

The signature algorithm of the certificate.

SHA256-RSA
PubkeyAlgorithmstring

The public-key algorithm of the certificate.

RSA
CreateTimestring

The time when the certificate was created.

2024-06-24 07:48:51
UpdateTimestring

The time when the certificate was updated.

2024-07-20 06:18:42

Examples

Sample success responses

JSONformat

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "TotalCount": 16,
  "PageNumber": 1,
  "PageSize": 20,
  "SiteId": 1234567890123,
  "SiteName": "example.com",
  "Result": [
    {
      "Id": "babab9db65ee5efcca9f3d41d4b5****",
      "Name": "yourCertName",
      "Status": "OK",
      "Type": "upload",
      "CommonName": "www.example.com ",
      "NotBefore": "2023-03-31 02:08:00",
      "NotAfter": "2024-03-31 02:08:00",
      "Issuer": "GlobalSign nv-sa",
      "SAN": "www.example.com,*.example.com",
      "SignatureAlgorithm": "SHA256-RSA",
      "PubkeyAlgorithm": "RSA",
      "CreateTime": "2024-06-24 07:48:51",
      "UpdateTime": "2024-07-20 06:18:42"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.SiteIdFailed to query the website based on the SiteID you specified. Check parameter SiteId and try again.Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.
400MissingSiteIdRequired parameter SiteId missing. Specify SiteId and try again.Required parameter SiteId missing. Specify SiteId and try again.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
403Unauthorized.InvalidTimeThe specified authentication time is invalid.The authentication time parameter you entered is invalid. Check the parameter value and try again.
403Unauthorized.InvalidTokenToken authentication failed.The token you entered is invalid. Please check and enter the correct token and try again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-03-12The Error code has changed. The response structure of the API has changedView Change Details