查询一个或多个密钥对。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:DescribeKeyPairs
RegionId String 密钥对所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。
KeyPairFingerPrint String 密钥对的指纹。根据 RFC4716 定义的公钥指纹格式,采用 MD5 信息摘要算法。更多详情,请参阅 RFC4716
KeyPairName String 密钥对名称。支持正则表达式模糊搜索,使用 * 匹配子表达式,示例:
  • *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不合法。