全部产品
云服务器 ECS

DescribeKeyPairs

更新时间:2017-09-13 14:33:57   分享:   

描述

查询密钥对列表。

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeKeyPairs。
RegionId String 密钥对所在的地域 ID。RegionId 的列表详见 地域列表
KeyPairFingerPrint String 密钥对的指纹,在 RFC4716 中定义的公钥指纹格式:MD5 信息摘要算法,参考 http://tools.ietf.org/html/rfc4716
KeyPairName String 密钥对名称,支持模糊搜索。正则匹配的方式,支持以下查询方式:
- *name,匹配 name 结尾的字符串(包括 name)。
- name*,匹配 name 开头的字符串(包括 name)。
- *name*,匹配中间有 name 的字符串(包括 name)。
- name,精确匹配 name。
PageNumber Integer 当前页码,起始值为 1,默认值为 1。
PageSize Integer 分页查询时设置的每页行数,最大值 50,默认值为 10。

返回参数

名称 类型 描述
TotalCount Integer 密钥对的总数。
PageNumber Integer 当前页码。
PageSize Integer 每页行数。
RegionId String 密钥对所属地域 ID。
KeyPairs KeyPairItemType 密钥对信息,由 KeyPairItemType 组成的集合。

错误码

错误代码 描述 HTTP 状态码 语义
MissingParameter The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 RegionId 参数未指定。RegionId 的列表详见 地域列表
InvalidParameter The specified parameter “PageNumber” is not valid. 400 指定的 PageNumber 参数不合法。
InvalidParameter The specified parameter “PageSize” is not valid. 400 指定的 PageSize 参数不合法。

示例

请求示例

  1. https://ecs.aliyuncs.com/?action= DescribeKeyPairs
  2. &RegionId=cn-qingdao
  3. & KeyPairFingerPrint=xxxxxxxxxx
  4. & KeyPairName=test
  5. & PageNumber=1
  6. & PageSize=20
  7. &<公共请求参数>

返回示例

XML 格式

  1. <DescribeKeyPairsResponse>
  2. <PageNumber>1</PageNumber>
  3. <PageSize>2</PageSize>
  4. <TotalCount>1</TotalCount>
  5. <KeyPairs>
  6. <KeyPair>
  7. <KeyPairName>test</KeyPairName >
  8. < KeyPairFingerPrint>xxxxxxxxxx</KeyPairFingerPrint>
  9. </KeyPair>
  10. </KeyPairs>
  11. <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  12. </DescribeKeyPairsResponse>
本文导读目录
本文导读目录
以上内容是否对您有帮助?