ListClientCaCertificates - List client CA certificates | ESA API - Edge Security Acceleration

Retrieves the list of client CA certificates for a specified 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:ListClientCaCertificates

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 obtain the site ID.	1234567890123
PageNumber	integer	No	The page number to return. Valid values: 1 to 500.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 100. Valid values: 1 to 100.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	F61CDR30-E83C-4FDA-BF73-9A94CDD44229
TotalCount	integer	The total number of entries.	16
PageNumber	integer	The page number of the returned data.	1
PageSize	integer	The number of entries per page.	20
SiteId	integer	The site ID.	1234567890123
SiteName	string	The site name.	example.com
Result	array<object>	The list of client CA certificates.
	object	The certificate information.
Id	string	The certificate ID.	babab9db65ee5efcca9f3d41d4b5****
Name	string	The certificate name.	yourCertName
Status	string	The certificate status.	OK
Type	string	The certificate type.	upload
CommonName	string	The common name of the certificate.	www.example.com
NotBefore	string	The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2023-03-31 02:08:00
NotAfter	string	The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2024-03-31 02:08:00
Issuer	string	The authority that issued the certificate.	GlobalSign nv-sa
SAN	string	The Subject Alternative Name (SAN) of the certificate.	www.example.com,*.example.com
SignatureAlgorithm	string	The signature algorithm of the certificate.	SHA256-RSA
PubkeyAlgorithm	string	The public key algorithm of the certificate.	RSA
CreateTime	string	The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2024-06-24 07:48:51
UpdateTime	string	The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2024-07-20 06:18:42
SerialNumber	string	The certificate sequence number.	babab022c5e9b27bf9c64d7f4b16****
FingerprintSha256	string	The SHA-256 fingerprint of the certificate.	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****

Examples

Success response

JSON format

{
  "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",
      "SerialNumber": "babab022c5e9b27bf9c64d7f4b16****",
      "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****"
    }
  ]
}

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.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
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.