Use DescribeKeyPairs to query key pairs - ENS

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

ens:DescribeKeyPairs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
KeyPairName	string	No	The name of the key pair that you want to bind to the simple application server. 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: Numbers. : _ . 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 elements

Element	Type	Description	Example
	object
KeyPairs	object
KeyPair	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.