DescribeKeyPairs
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口 (DescribeKeyPairs) 用于查询密钥对信息。
- 密钥对是通过一种算法生成的一对密钥，在生成的密钥对中，一个向外界公开，称为公钥；另一个用户自己保留，称为私钥。密钥对的公钥内容可以通过这个接口查询，但私钥内容系统不保留。
默认接口请求频率限制：10次/秒。
接口更新时间：2023-07-19 10:40:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeKeyPairs |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| KeyIds | 否 | 否 | Array of String | 密钥对ID，密钥对ID形如：skey-11112222（此接口支持同时传入多个ID进行过滤。此参数的具体格式可参考 API 简介的 id.N 一节）。参数不支持同时指定 KeyIds 和 Filters。<br> 密钥对ID可以通过登录控制台查询。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件，详见密钥对过滤条件表。参数不支持同时指定 KeyIds 和 Filters。 |
| Offset | 否 | 否 | Int64 | 偏移量，默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为20，最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 符合条件的密钥对数量。 |
| KeyPairSet | KeyPair | 此参数对外不可见。 密钥对详细信息列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidFilter | 无效的过滤器。 |
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
| InvalidParameterValueLimit | 参数值数量超过限制。 |
| InvalidParameterValueOffset | 无效参数值。指定的 Offset 无效。 |
| InvalidFilterValue.LimitExceeded | Filter参数值数量超过限制。 |
| InvalidKeyPairId.Malformed | 无效密钥对ID。指定的密钥对ID格式错误，例如 ID 长度错误skey-1122。 |
| InvalidKeyPair.LimitExceeded | 密钥对数量超过限制。 |
| InternalServerError | 操作内部错误。 |
| InvalidParameter | 无效参数。参数不合要求或者参数不被支持等。 |