DescribeKeyPairs - 查询密钥对列表 - 云服务器 ECS

调用DescribeKeyPairs查询一个或多个密钥对。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeKeyPairs	get	KeyPair `acs:ecs:{#regionId}:{#accountId}:keypair/{#keypairName}` KeyPair `acs:ecs:{#regionId}:{#accountId}:keypair/*`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	密钥对所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
KeyPairName	string	否	密钥对名称。支持正则表达式模糊搜索，使用匹配子表达式，示例： `SshKey`：查询以 SshKey 结尾的密钥对名称，包括 SshKey。 `SshKey`：查询以 SshKey 开头的密钥对名称，包括 SshKey。 `SshKey*`：查询名称中间有 SshKey 的密钥对，包括 SshKey。 `SshKey`：精确匹配 SshKey。	SshKey
KeyPairFingerPrint	string	否	密钥对的指纹。根据 RFC 4716 定义的公钥指纹格式，采用 MD5 信息摘要算法。更多详情，请参见RFC 4716。	ABC1234567
PageNumber	integer	否	密钥对列表的页码。起始值：1。默认值：1 。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10 。	10
IncludePublicKey	boolean	否	是否在返回结果中包含 PublicKey。默认值：false。	false
ResourceGroupId	string	否	密钥对所在的企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-amnhr7u7c7hj****
Tag	array<object>	否	标签列表。
	object	否
Key	string	否	密钥对的标签键。N 的取值范围：1~20。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。	TestKey
Value	string	否	密钥对的标签值。N 的取值范围：1~20。	TestValue

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页行数。	10
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	当前页码。	1
TotalCount	integer	密钥对的总数。	1
KeyPairs	array<object>	密钥对信息集合。
KeyPair	object
CreationTime	string	密钥对的创建时间。	2023-09-04T08:33Z
KeyPairName	string	密钥对的名称。	testKeyPairName
KeyPairFingerPrint	string	密钥对的指纹。	ABC1234567
ResourceGroupId	string	资源组 ID。	rg-amnhr7u7c7hj****
PublicKey	string	公钥内容。	ssh-rsa****
Tags	array<object>	密钥对的标签。
Tag	object
TagValue	string	密钥对的标签值。	TestValue
TagKey	string	密钥对的标签键。	TestKey

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2023-09-04T08:33Z",
        "KeyPairName": "testKeyPairName",
        "KeyPairFingerPrint": "ABC1234567",
        "ResourceGroupId": "rg-amnhr7u7c7hj****",
        "PublicKey": "ssh-rsa****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-17	OpenAPI 描述信息更新	查看变更详情
2024-02-01	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情