All Products
Search
Document Center

Elastic Compute Service:DescribeKeyPairs

Last Updated:Mar 19, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the key pair. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
KeyPairNamestringNo

The name of the key pair. You can use the asterisk (*) symbol as a wildcard in regular expressions to perform a fuzzy search for key pairs. Sample patterns:

  • *SshKey: queries key pairs whose names end with SshKey, including the key pair named SshKey.
  • SshKey*: queries key pairs whose names start with SshKey, including the key pair named SshKey.
  • *SshKey*: queries key pairs whose names include SshKey, including the key pair named SshKey.
  • SshKey: queries the key pair named SshKey.
*SshKey*
KeyPairFingerPrintstringNo

The fingerprint of the key pair. The message-digest algorithm 5 (MD5) is used based on the public key fingerprint format defined in RFC 4716. For more information, see RFC 4716.

ABC1234567
PageNumberintegerNo

The number of the page to return. Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 50.

Default value: 10.

10
ResourceGroupIdstringNo

The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

Note Resources in the default resource group are displayed in the response regardless of how this parameter is set.
rg-amnhr7u7c7hj****
Tagobject []No

The tags.

KeystringNo

The key of tag N of the key pair. Valid values of N: 1 to 20.

If a single tag is specified to query resources, up to 1,000 resources that are bound with this tag can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that are bound with all these tags can be displayed in the response. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation.

TestKey
ValuestringNo

The value of tag N of the key pair. Valid values of N: 1 to 20.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of key pairs.

1
KeyPairsobject []

Details about the key pairs.

CreationTimestring

The time when the key pair was created.

2023-09-04T08:33Z
KeyPairNamestring

The name of the key pair.

testKeyPairName
KeyPairFingerPrintstring

The fingerprint of the key pair.

ABC1234567
ResourceGroupIdstring

The ID of the resource group.

rg-amnhr7u7c7hj****
Tagsobject []

The tags of the key pair.

TagValuestring

The tag value of the key pair.

TestValue
TagKeystring

The tag key of the key pair.

TestKey

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2023-09-04T08:33Z",
        "KeyPairName": "testKeyPairName",
        "KeyPairFingerPrint": "ABC1234567",
        "ResourceGroupId": "rg-amnhr7u7c7hj****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-01The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: IncludePublicKey
Output ParametersThe response structure of the API has changed.