ListKeylessServers - Edge Security Acceleration - Alibaba Cloud Documentation Center

Retrieves the list of Keyless server configurations for a 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:ListKeylessServers

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.	1
PageSize	integer	No	The number of records per page.	20

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
TotalCount	integer	The total number of records.	90
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	20
SiteId	integer	The site ID.	54362329990032
SiteName	string	The site name.	example.com
Result	array<object>	The result array.
	object	The result.
Id	string	Keyless server ID。	babab9db65ee5efcca9f3d41d4b5****
Name	string	The Keyless server name.	example
Host	string	The Keyless server hostname.	example.com
Port	integer	The Keyless server port. Valid values: 1 to 65535.	443
Verify	boolean	Indicates whether to verify the Keyless server certificate. Default value: false.	true
CaCertificate	string	The CA certificate used to verify the Keyless server certificate. This parameter takes effect only when Verify is set to true.	-----BEGIN CERTIFICATE-----****
ClientCertificate	string	The client certificate. This parameter must be used together with the client private key.	-----BEGIN CERTIFICATE-----****
ClientPrivateKey	string	The client private key. This parameter must be used together with the client certificate.	-----BEGIN RSA PRIVATE KEY-----****
CreateTime	string	The creation time. The time follows the format YYYY-MM-DDTHH:MM:SS+08:00 in the UTC/GMT time zone.	2025-07-18T20:33:31+08:00
UpdateTime	string	The update time. The time follows the format YYYY-MM-DDTHH:MM:SS+08:00 in the UTC/GMT time zone.	2025-07-18T20:33:31+08:00

Examples

Success response

JSON format

{
  "RequestId": "CB1A380B-09F0-41BB-280B-72F8FD6DA2FE",
  "TotalCount": 90,
  "PageNumber": 1,
  "PageSize": 20,
  "SiteId": 54362329990032,
  "SiteName": "example.com ",
  "Result": [
    {
      "Id": "babab9db65ee5efcca9f3d41d4b5****",
      "Name": "example",
      "Host": "example.com",
      "Port": 443,
      "Verify": true,
      "CaCertificate": "-----BEGIN CERTIFICATE-----****",
      "ClientCertificate": "-----BEGIN CERTIFICATE-----****",
      "ClientPrivateKey": "-----BEGIN RSA PRIVATE KEY-----****",
      "CreateTime": "2025-07-18T20:33:31+08:00",
      "UpdateTime": "2025-07-18T20:33:31+08:00"
    }
  ]
}

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.