文档

DescribeKeyPairs - 查询一个或多个密钥对

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
KeyPairNamestring

密钥对名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以http://https://开头。可以包含以下字符:

  • 数字
  • :
  • _

仅支持传单个名称。默认查询所有密钥对信息。

TestKeyPairName
PageNumberstring

查询列表的页码。取值:>0,默认查询第 1 页。

1
PageSizestring

分页查询时设置的每页行数。取值:>0,默认为 10。

10

返回参数

名称类型描述示例值
object
KeyPairsobject []

密钥对信息。

CreationTimestring

密钥对的创建时间。日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为 yyyy-MM-ddTHH:mm:ssZ。

2020-04-26T15:38:27Z
KeyPairFingerPrintstring

密钥对的指纹。

fdaf8ff7a756ef843814fc****
KeyPairNamestring

密钥对的名称。

TestKeyPairName
PageNumberinteger

当前页码。

1
PageSizeinteger

每页行数。

10
RequestIdstring

请求 ID。

37B52F33-6879-49D0-A39B-22966B01449E
TotalCountinteger

密钥对的总数。

7

示例

正常返回示例

JSON格式

{
  "KeyPairs": {
    "KeyPair": [
      {
        "CreationTime": "2020-04-26T15:38:27Z",
        "KeyPairFingerPrint": "fdaf8ff7a756ef843814fc****",
        "KeyPairName": "TestKeyPairName",
        "KeyPairId": ""
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "37B52F33-6879-49D0-A39B-22966B01449E",
  "TotalCount": 7
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.接口调用出错。

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

变更历史

变更时间变更内容概要操作
2024-01-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:KeyPairId
出参OpenAPI 返回结构发生变更
2023-12-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
入参OpenAPI 入参发生变更
    删除入参:Version
  • 本页导读 (1)
文档反馈