说明:
1. 接口描述
本接口 (DescribeKeyPairs) 用于查询密钥对信息。
接口请求域名:cvm.api.qcloud.com
2. 输入参数
参数名称 | 类型 | 是否必选 | 描述 |
Version | String | 是 | 表示 API 版本号,主要用于标识请求的不同 API 版本。 本接口第一版本可传:2017-03-12。 |
KeyIds.N | Array of Strings | 否 | 密钥对 ID,密钥对 ID 形如: skey-11112222 (此接口支持同时传入多个 ID 进行过滤。此参数的具体格式可参考 API 简介的 id.N 一节)。参数不支持同时指定 KeyIds 和 Filters 。 |
Filters.N | 否 | 过滤条件,详见密钥对过滤条件表。参数不支持同时指定 KeyIds 和 Filters 。 | |
Offset | Integer | 否 | |
Limit | Integer | 否 |
密钥对过滤条件表
参数名称 | 类型 | 是否必选 | 描述 |
project-id | Integer | 否 | (过滤条件)按照项目 ID 过滤。 可以通过以下方式获取项目 ID: 通过 项目列表 查询项目 ID。 通过调用接口 DescribeProject,取返回信息中的 projectId 获取项目 ID。 |
key-name | String | 否 | (过滤条件)按照密钥对名称过滤。 |
3. 输出参数
参数名称 | 类型 | 描述 |
RequestId | String | 唯一请求 ID 。每次请求都会返回RequestId 。当用户调用接口失败找后台研发人员处理时需提供该RequestId 。 |
TotalCount | Integer | 符合条件的密钥对数量。 |
KeyPairSet | 密钥对详细信息列表。 |
4. 错误码
错误码 | 描述 |
InvalidParameter | 无效参数。参数不合要求或者参数不被支持等。 |
InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
InvalidParameterValueLimit | 参数值数量超过限制。 |
InvalidParameterValueOffset | 无效参数值。指定的 Offset 无效。 |
InvalidFilterValue.LimitExceeded | Filter 参数值数量超过限制。 |
InvalidFilter | |
InvalidKeyPairId.Malformed | 无效密钥对ID。指定的密钥对ID格式错误,例如 ID 长度错误skey-1122 。 |
InvalidKeyPair.LimitExceeded | 密钥对数量超过限制。 |
InternalServerError | 操作内部错误。 |
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=DescribeKeyPairs&Version=2017-03-12&Filters.1.Name=key-name&Filters.1.Values.1=Tencent&Offset=0&Limit=20&<公共请求参数>
输出
{"Response": {"TotalCount": 1,"KeyPairSet": [{"KeyId": "skey-mv9yzyjj","KeyName": "Tencent","Description": "","PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKOJQIK69c1Asy1UO88cxEbujR5Jbr0e/Ey1v4ZKAUzDnsBnFlf4hKPA1YvMB8RBYj4GcLtM7PrKnBNNram8rgl73X/klOO8oqKv+J/XUA7KHH1Y6wcn1RTRTMdDHbGhW1q/UpfeylNTbf+wEIWhEfaL5FKQm4hqCw== skey_112168","AssociatedInstanceIds": [],"CreateTime": "2016-12-02T00:22:40Z"}],"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"}}