查詢一個或多個金鑰組。

請求參數

名稱 類型 是否必需 描述
Action String 是 系統規定參數。取值：DescribeKeyPairs
RegionId String 是 金鑰組所在的地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。
KeyPairFingerPrint String 否 金鑰組的指紋。根據 RFC4716 定義的公開金鑰指紋格式，採用 MD5 資訊摘要演算法。更多詳情，請參閱 RFC4716。
KeyPairName String 否 金鑰組名稱。支援Regex模糊搜索，使用 * 匹配子運算式，樣本：
  • *SshKey：查詢以 SshKey 結尾的金鑰組名稱，包括 SshKey。
  • SshKey*：查詢以 SshKey 開頭的金鑰組名稱，包括 SshKey。
  • *SshKey*：查詢名稱中間有 SshKey 的金鑰組，包括 SshKey。
  • SshKey：精確匹配 SshKey。
PageNumber Integer 否 金鑰組列表的頁碼。起始值：1

預設值：1
PageSize Integer 否 分頁查詢時設定的每頁行數。最大值：50

預設值：10

返回參數

名稱 類型 描述
TotalCount Integer 金鑰組的總數。
PageNumber Integer 當前頁碼。
PageSize Integer 每頁行數。
RegionId String 金鑰組所屬地域 ID。
KeyPairs KeyPairItemType 金鑰組資訊集合。

樣本

請求樣本 
https://ecs.aliyuncs.com/?Action=DescribeKeyPairs
&RegionId=cn-qingdao
&KeyPairFingerPrint=xxxxxxxxxx
&KeyPairName=test
&PageNumber=1
&PageSize=20
&<公共請求參數>
返回樣本

XML 格式

<DescribeKeyPairsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <KeyPairs>
        <KeyPair>
            <KeyPairName>test</KeyPairName >
            <KeyPairFingerPrint>xxxxxxxxxx</KeyPairFingerPrint>
        </KeyPair>
    </KeyPairs>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DescribeKeyPairsResponse>
JSON 格式 
{
    "PageNumber": 1,
    "PageSize": 2,
    "TotalCount": 1,
    "KeyPairs": {
        "KeyPair":[{
            "KeyPairName": "test",
            "KeyPairFingerPrint": "xxxxxxxxxx"
        }]
    }
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼，請訪問 API 錯誤中心。

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
MissingParameter The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 您必須指定 RegionId參數。
InvalidParameter The specified parameter “PageNumber” is not valid. 400 指定的參數 PageNumber不合法。
InvalidParameter The specified parameter “PageSize” is not valid. 400 指定的參數 PageSize不合法。