DescribeKeyPairs - ENS - Alibaba Cloud Documentation Center

Queries one or more key pairs.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
ens:DescribeKeyPairs	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
KeyPairName	string	No	The name of the key pair. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain the following characters: Digits : _ You can specify only one name. By default, all key pairs are queried.	TestKeyPairName
PageNumber	string	No	The page number of the returned page. Valid values: integers that are greater than 0. Default value: 1.	1
PageSize	string	No	The number of entries per page. Valid values: integers that are greater than 0. Default value: 10.	10
KeyPairId	string	No	The ID of the key pair.	ssh-50cynkq42sgj4ej1tn78t4***

Response parameters

Parameter	Type	Description	Example
	object
KeyPairs	array<object>	Details about the key pairs.
	object
CreationTime	string	The time when the key pair was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2020-04-26T15:38:27Z
KeyPairFingerPrint	string	The fingerprint of the key pair.	fdaf8ff7a756ef843814fc****
KeyPairName	string	The name of the SSH key pair.	TestKeyPairName
KeyPairId	string	The ID of the key pair.	ssh-50cynkq42sgj4ej1tn78t4***
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	37B52F33-6879-49D0-A39B-22966B01449E
TotalCount	integer	The total number of key pairs.	7

Examples

Sample success responses

JSONformat

{
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2020-04-26T15:38:27Z",
        "KeyPairFingerPrint": "fdaf8ff7a756ef843814fc****",
        "KeyPairName": "TestKeyPairName",
        "KeyPairId": "ssh-50cynkq42sgj4ej1tn78t4***"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "37B52F33-6879-49D0-A39B-22966B01449E",
  "TotalCount": 7
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.	-
400	NoPermission	Permission denied.	-
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-
400	InvalidParameter	The errorMessage is %s. Please check it again.	-
400	ens.interface.error	An error occurred while calling the API.	-
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

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

Change history

Change time	Summary of changes	Operation
2024-01-22	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-12-21	API Description Update. The Error code has changed. The request parameters of the API has changed	View Change Details