All Products
Search
Document Center

ENS:DescribeKeyPairs

Last Updated:Nov 18, 2024

Queries one or more key pairs.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeKeyPairsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
KeyPairNamestringNo

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
PageNumberstringNo

The page number of the returned page. Valid values: integers that are greater than 0. Default value: 1.

1
PageSizestringNo

The number of entries per page. Valid values: integers that are greater than 0. Default value: 10.

10
KeyPairIdstringNo

The ID of the key pair.

ssh-50cynkq42sgj4ej1tn78t4***

Response parameters

ParameterTypeDescriptionExample
object
KeyPairsarray<object>

Details about the key pairs.

KeyPairobject
CreationTimestring

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
KeyPairFingerPrintstring

The fingerprint of the key pair.

fdaf8ff7a756ef843814fc****
KeyPairNamestring

The name of the SSH key pair.

TestKeyPairName
KeyPairIdstring

The ID of the key pair.

ssh-50cynkq42sgj4ej1tn78t4***
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

37B52F33-6879-49D0-A39B-22966B01449E
TotalCountinteger

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 codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall 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 timeSummary of changesOperation
2024-01-22The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details