ListKeyPairs - Simple Application Server - Alibaba Cloud Documentation Center

Queries the AccessKey pairs that are bound to simple application servers in a specific region.

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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
swas-open:ListKeyPairs	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application servers. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
KeyPairName	string	No	The name of the AccessKey pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.	KeyPairName
PageNumber	integer	No	The page number. Page starts from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	3
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
KeyPairs	array<object>	Details about the queried AccessKey pairs.
KeyPair	object
CreationTime	string	The time when the AccessKey pair was created.	2024-05-06T02:28Z
KeyPairName	string	The name of the AccessKey pair. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter and cannot start with http:// or https://.	testKeyPairName
PublicKey	string	The content of the public key.	ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****
InstanceIds	array	The IDs of simple application servers. A maximum of 50 IDs of simple application servers can be returned.
InstanceId	string	The ID of the simple application server. A maximum of 50 IDs of simple application servers can be returned.	2ad1ae67295445f598017499dc****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 3,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "KeyPairs": [
    {
      "CreationTime": "2024-05-06T02:28Z",
      "KeyPairName": "testKeyPairName",
      "PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbO5Govwhb0iHzoMYKkIQxjlHyHH8nxFsW6KF5saxgYhOwdeIpWngpi+/NDWQKvuOnXFFDh/o3eJJkh3rqP+RlMggt4HLQWOd9TS0f4/cgbAzud1caW9PnankCr****",
      "InstanceIds": [
        "2ad1ae67295445f598017499dc****"
      ]
    }
  ]
}

Error codes

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