ListCertificates - List site certificates | ESA API - Edge Security Acceleration

Queries the certificate list for a specific site.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:ListCertificates

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to query the site ID.	1234567890123
Keyword	string	No	The search keyword.	example
ValidOnly	boolean	No	Specifies whether to return only valid certificates.	true
PageNumber	integer	No	The page number of the data to return.	3
PageSize	integer	No	The number of records per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
TotalCount	integer	The total number of records.	10
PageNumber	integer	The page number of the data to return.	1
PageSize	integer	The number of records per page.	20
SiteId	integer	The site ID.	1234567890123
SiteName	string	The site name.	example.com
Result	array<object>	The result array.
	array<object>	The result.
CasId	string	The cloud certificate ID.	30000569
Id	string	The certificate ID.	baba39055622c008b90285a8838e****
Name	string	The certificate name.	yourCertName
Region	string	The region information.	cn-hangzhou
Status	string	The certificate status. Valid values: OK: Normal. Expired: The certificate has expired. Expiring: The certificate is about to expire (within 30 days). Issued: Free certificate - issued. Applying: Free certificate - applying. ApplyFailed: Free certificate - application failed. Canceled: Free certificate - canceled. Valid values: Expiring : The certificate is about to expire (within 30 days). Issued : Free certificate - issued. Expired : The certificate has expired. Applying : Free certificate - applying. OK : Normal.	OK
Type	string	The certificate type. Valid values: cas: SSL Certificates Service certificate. upload: Custom uploaded certificate. free: Free certificate. keyless: Keyless certificate. Valid values: cas : SSL Certificates Service certificate. upload : Custom uploaded certificate. keyless : Keyless certificate. free : Free certificate.	free
CommonName	string	The common name of the certificate.	www.example.com
NotBefore	string	The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.	2023-03-31 02:08:00
NotAfter	string	The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.	2024-03-31 02:08:00
Issuer	string	The certificate issuer.	GlobalSign nv-sa
IssuerCN	string	The common name of the certificate issuer.	GlobalSign Organization Validation CA - SHA256 - G3
SAN	string	The Subject Alternative Name (SAN) of the certificate.	www.example.com,*.example.com
SigAlg	string	The signature algorithm of the certificate.	SHA256-RSA
PubAlg	string	The public key algorithm of the certificate.	RSA
CreateTime	string	The creation time. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.	2022-06-24 07:48:51
UpdateTime	string	The update time. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.	2023-04-20 06:18:42
SerialNumber	string	The certificate serial number.	babab022c5e9b27bf9c64d7f4b16****
FingerprintSha256	string	The SHA-256 fingerprint of the certificate.	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****
DCV	array<object>	The Domain Control Validation (DCV) information.
	object	The Domain Control Validation (DCV) information.
Id	string	The ID of the DCV record.	bababf7cdd1546a2ad04c0def1f4****
Type	string	The DCV method. Valid values: `DNS` and `HTTP`. Valid values: DNS : DNS HTTP : HTTP	HTTP
Key	string	The DCV key. For the `DNS` method, this is the name of the TXT record. For the `HTTP` method, this is the URL.	http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow
Value	string	The DCV value.	pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ
Status	string	The validation status.	pending
ApplyCode	integer	The error code for the certificate application.	2
ApplyMessage	string	The error message for the certificate application.	canceled
KeyServerId	string	The Keyless server ID. This parameter is valid only when Type is set to keyless.	baba39055622c008b90285a8838e****

Examples

Success response

JSON format

{
  "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",
      "KeyServerId": "baba39055622c008b90285a8838e****\n"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.SiteId	Failed 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.
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	Required parameter SiteId missing. Specify SiteId and try again.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The authentication time parameter you entered is invalid. Check the parameter value and try again.
403	Unauthorized.InvalidToken	Token authentication failed.	The token you entered is invalid. Please check and enter the correct token and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.