All Products
Search
Document Center

Edge Security Acceleration:ListCertificates

Last Updated:Nov 15, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Lists certificates of 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:ListCertificateslist
*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
KeywordstringNo

The keyword that is used for the search.

example
ValidOnlybooleanNo

Specifies whether to return only valid certificates.

1
PageNumberlongNo

The page number.

3
PageSizelongNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

15C66C7B-671A-4297-9187-2C4477247A74
TotalCountlong

The total number of entries returned.

10
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 certificates.

CertItemobject

Details of the certificates.

CasIdstring

The certificate ID on Certificate Management Service.

30000569
Idstring

The certificate ID on ESA.

baba39055622c008b90285a8838e****
Namestring

The certificate name.

yourCertName
Regionstring

The region where the certificate is stored.

cn-hangzhou
Statusstring

The certificate status.

  • OK
  • Expired
  • Expiring
  • Issued
  • Applying
  • ApplyFailed
  • Canceled
OK
Typestring

The certificate type.

  • cas: certificate that is purchased by using Certificate Management Service
  • upload: custom certificate that you upload
  • free: free certificate
free
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 certificate authority (CA) that issued the certificate.

GlobalSign nv-sa
IssuerCNstring

The Common Name of the certificate issuer.

GlobalSign Organization Validation CA - SHA256 - G3
SANstring

The Subject Alternative Name (SAN) of the certificate.

www.example.com,*.example.com
SigAlgstring

The signature algorithm of the certificate.

SHA256-RSA
PubAlgstring

The public key algorithm of the certificate.

RSA
CreateTimestring

The time when the certificate was created.

2022-06-24 07:48:51
UpdateTimestring

The time when the certificate was updated.

2023-04-20 06:18:42
SerialNumberstring

The serial number of the certificate.

babab022c5e9b27bf9c64d7f4b16****
FingerprintSha256string

The SHA-256 fingerprint of the certificate.

1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****
DCVarray<object>

The Domain Control Validation (DCV) information.

DCVobject

The DCV information.

Idstring

The DCV ID.

bababf7cdd1546a2ad04c0def1f4****
Typestring

The DCV type. Valid values: DNS and HTTP.

HTTP
Keystring

The DCV name. It is a TXT record name if Type is DNS or URL if Type is HTTP.

http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow
Valuestring

The DCV content.

pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ
Statusstring

The verification status.

pending
ApplyCodelong

The error code returned for certificate application.

2
ApplyMessagestring

The error message returned for certificate application.

canceled

Examples

Sample success responses

JSONformat

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount": 10,
  "PageNumber": 1,
  "PageSize": 20,
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Result": [
    {
      "CasId": 30000569,
      "Id": "baba39055622c008b90285a8838e****",
      "Name": "yourCertName",
      "Region": "cn-hangzhou",
      "Status": "OK",
      "Type": "free",
      "CommonName": "www.example.com",
      "NotBefore": "2023-03-31 02:08:00",
      "NotAfter": "2024-03-31 02:08:00",
      "Issuer": "GlobalSign nv-sa",
      "IssuerCN": "GlobalSign Organization Validation CA - SHA256 - G3",
      "SAN": "www.example.com,*.example.com",
      "SigAlg": "SHA256-RSA",
      "PubAlg": "RSA",
      "CreateTime": "2022-06-24 07:48:51",
      "UpdateTime": "2023-04-20 06:18:42",
      "SerialNumber": "babab022c5e9b27bf9c64d7f4b16****",
      "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****",
      "DCV": [
        {
          "Id": "bababf7cdd1546a2ad04c0def1f4****",
          "Type": "HTTP",
          "Key": "http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow",
          "Value": "pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ",
          "Status": "pending"
        }
      ],
      "ApplyCode": 2,
      "ApplyMessage": "canceled"
    }
  ]
}

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