说明：当前页面接口为旧版 API，未来可能停止维护，目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范，访问时延下降显著，建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (DescribeKeyPairs) 用于查询密钥。
接口请求域名：cvm.api.qcloud.com
- 密钥对 是通过一种算法生成的一对密钥，在生成的密钥对中，一个向外界公开，称为公钥；另一个用户自己保留，称为私钥。密钥的公钥内容可以通过这个接口查询，但私钥内容系统不保留。
- 可通过
keyIds.n或keyName输入参数作为过滤条件查询。
2. 输入参数
以下请求参数列表仅列出了接口请求参数，其它参数见 公共请求参数 页面。
| 参数名称 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
| keyIds.n | 否 | String | 密钥ID（此接口支持同时传入多个ID进行过滤。此参数的具体格式可参考 API 简介 的id.n一节）。 |
| keyName | 否 | String | 密钥名称。 |
| projectId | 否 | String | 项目 ID，使用项目 ID 过滤结果。 |
| offset | 否 | Int | 偏移量，默认为0。关于offset的更进一步介绍参考 API 简介 中的相关小节。 |
| limit | 否 | Int | 返回数量，默认 20，最大值 100。关于limit的更进一步介绍参考 API 简介 中的相关小节。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Int | 公共错误码。0表示成功，其他值表示失败。 |
| message | String | 模块错误信息描述，与接口相关。 |
| totalCount | int | 符合过滤条件的密钥个数。 |
| keyId | String | 密钥ID。 |
| keyName | String | 密钥名称。 |
| pubkey | String | 密钥的公钥内容。 |
| status | int | 密钥状态。0为正常，1为非正常。 |
| bindUnInstanceIds | int | 绑定的实例ID列表。 |
| bindIps | String List | 绑定的实例IP列表。 |
| createTime | String | 密钥的创建时间。 |
4. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=DescribeKeyPairs &<公共请求参数>
输出
{
"code": 0,
"message": "",
"data": {
"totalCount": 2,
"sshSet": [
{
"keyId": "skey-xxxx",
"keyName": "test1",
"pubkey": "ssh-rsa xxxxxx skey_32228",
"status": 0,
"bindIps": [
],
"createTime": "2015-11-05 17:26:21",
"bindUnInstanceIds": [
]
},
{
"keyId": "skey-xxxxx",
"keyName": "test2",
"pubkey": "ssh-rsa xxxxxx skey_32228",
"status": 0,
"bindIps": [
"xx.xx.xx.xx"
],
"createTime": "2015-11-06 20:52:21",
"bindUnInstanceIds": [
"ins-xxxxxx"
]
}
]
}
}