调用DescribeKeyPairs查询一个或多个密钥对。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeKeyPairs

系统规定参数，操作接口名，取值：DescribeKeyPairs。

Version String 是 2017-11-10

版本号，取值：2017-11-10。
KeyPairName String 否 TestKeyPairName

密钥对名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://和https://开头。可以包含以下字符：

  • 数字
  • :
  • _
  • -

仅支持传单个名称。默认查询所有密钥对信息。
PageNumber String 否 1

查询列表的页码。取值：>0，默认查询第1页。
PageSize String 否 10

分页查询时设置的每页行数。取值：>0，默认为10。

返回数据

名称 类型 示例值 描述
KeyPairs Array of KeyPair

密钥对信息。
KeyPair
CreationTime String 2020-04-26T15:38:27Z

密钥对的创建时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。
KeyPairFingerPrint String fdaf8ff7a756ef843814fc****

密钥对的指纹。
KeyPairName String TestKeyPairName

密钥对的名称。
PageNumber Integer 1

当前页码。
PageSize Integer 10

每页行数。
RequestId String 37B52F33-6879-49D0-A39B-22966B01449E

请求ID。
TotalCount Integer 7

密钥对的总数。

示例

请求示例

https://ens.aliyuncs.com/?Action=DescribeKeyPairs
&Version=2017-11-10
&KeyPairName=TestKeyPairName
&<公共请求参数>

正常返回示例

XML格式 

<DescribeKeyPairsResponse>
  <TotalCount>7</TotalCount>
  <RequestId>37B52F33-6879-49D0-A39B-22966B01449E</RequestId>
  <PageSize>10</PageSize>
  <PageNumber>1</PageNumber>
  <KeyPairs>
        <KeyPair>
              <KeyPairFingerPrint>fdaf8ff7a756ef843814fc****</KeyPairFingerPrint>
              <KeyPairName>TestKeyPairName</KeyPairName>
              <CreationTime>2020-04-26T15:38:27Z</CreationTime>
        </KeyPair>
  </KeyPairs>
</DescribeKeyPairsResponse>

JSON格式 

{
    "TotalCount":7,
    "RequestId":"37B52F33-6879-49D0-A39B-22966B01449E",
    "PageSize":10,
    "PageNumber":1,
    "KeyPairs":{
        "KeyPair":[
            {
                "KeyPairFingerPrint":"fdaf8ff7a756ef843814fc****",
                "KeyPairName":"TestKeyPairName",
                "CreationTime":"2020-04-26T15:38:27Z"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission Permission denied. 没有足够的权限，请联系云账号管理员授予您相应权限。

访问错误中心查看更多错误码。