文档中心

云服务器

请输入

密钥对

DescribeKeyPairs - 查询密钥对列表

调用 DescribeKeyPairs 接口查询密钥对列表信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeKeyPairs

要执行的操作，取值：DescribeKeyPairs。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

FingerPrint string 可选示例值：4158f40dbc0814eb04f0dcac4e******

密钥对的指纹。根据RFC4716定义的公钥指纹格式，采用MD5信息摘要算法。

KeyPairIds.N string[] 可选示例值：KeyPairIds.1=kp-ybp0x6i30gep29******

密钥对ID，最多支持100个。

参数 - N：表示密钥对ID的序号。

多个密钥对ID之间用&分隔。

KeyPairName string 可选示例值：ssh-asfas

密钥对名称，支持模糊搜索。

KeyPairNames.N string[] 可选示例值：KeyPairNames.1=ssh_key_pair

密钥对名称，最多支持100个。

参数 - N：表示密钥对的序号。

多个密钥对之间用&分隔。

MaxResults integer 可选示例值：10

分页查询时设置的每页行数。

最大值：500

默认值：10

NextToken string 可选示例值：--

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

ProjectName string 可选示例值：project_a

资源所属项目，一个资源只能归属于一个项目。

只能包含字母、数字、下划线“_”、点“.”和中划线“-”。

长度限制在64个字符以内。

TagFilters.N.Key string[] 可选示例值：TagFilters.1.Key=k1

根据标签查询资源时指定的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

不允许重复。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

不传则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

KeyPairs object[] 示例值：--

密钥对信息。

Tags object[] 示例值：--

资源的标签信息。

Key string 示例值：k1

资源的标签键。

Value string 示例值：v1

资源的标签值。

CreatedAt string 示例值：2021-05-21T18:40:43+08:00

密钥对创建时间。

Description string 示例值：ssh_key_pair description

密钥对的描述信息。

FingerPrint string 示例值：4158f40dbc0814eb04f0dcac4e******

密钥对的指纹。根据RFC4716定义的公钥指纹格式，采用MD5信息摘要算法。

KeyPairId string 示例值：kp-ybp0x6i30gep29******

密钥对唯一ID。

KeyPairName string 示例值：ssh_key_pair

密钥对名称。

ProjectName string 示例值：project_a

资源所属项目。

UpdatedAt string 示例值：2021-05-21T18:40:55+08:00

密钥对更新时间。

NextToken string 示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeKeyPairs&Version=2020-04-01&MaxResults=1 HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20241112104303225137085107A08E47",​
    "Action": "DescribeKeyPairs",​
    "Version": "2020-04-01",​
    "Service": "ecs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "KeyPairs": [​
      {​
        "Tags": [​
          {​
            "Key": "k1",​
            "Value": "v1"​
          }​
        ],​
        "CreatedAt": "2021-05-21T18:40:43+08:00",​
        "Description": "ssh_key_pair description",​
        "FingerPrint": "4158f40dbc0814eb04f0dcac4e******",​
        "KeyPairId": "kp-ybp0x6i30gep29******",​
        "KeyPairName": "ssh_key_pair",​
        "ProjectName": "project_a",​
        "UpdatedAt": "2021-05-21T18:40:55+08:00"​
      }​
    ],​
    "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******"​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	InvalidTagFilterKey.Malformed	The specified TagFilterKey is malformed.	指定的查询标签的键格式错误。
400	InvalidTagFilterValue.Malformed	The specified TagFilterValue is malformed.	指定的查询标签的值格式错误。
400	LimitExceeded.MaximumKeyPairIds	You've reached the limit on the number of KeyPairIds that you can set.	指定的密钥对ID数量超过最大限制。
400	LimitExceeded.MaximumKeyPairNames	You've reached the limit on the number of KeyPairNames that you can set.	指定的密钥对名称数量超过最大限制。
400	LimitExceeded.MaximumTagFilterKeys	You've reached the limit on the number of TagFilterKeys that you can set.	指定的查询标签键超出取值范围。
400	LimitExceeded.MaximumTagFilterResults	You've reached the limit on the number of resources that you can describe by TagFilters.	通过标签过滤出的资源数量超过上限。
400	LimitExceeded.MaximumTagFilterValues	You've reached the limit on the number of TagFilterValues that you can set.	指定的查询标签值超出取值范围。
409	InvalidTagFilterKey.Conflict	The specified TagFilterKey already exists.	指定的过滤标签键已存在。
429	FlowLimitExceeded	You've reach the limit on request rate of resources.	您已超过资源请求限速。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2025.09.04 16:59:40

这个页面对您有帮助吗？

有用

无用