调用DescribeKeyPairs查询一个或多个密钥对。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ens:DescribeKeyPairs | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| KeyPairName | string | 否 | 密钥对名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头，不能以
仅支持传单个名称。默认查询所有密钥对信息。 | TestKeyPairName |
| PageNumber | string | 否 | 查询列表的页码。取值：>0，默认查询第 1 页。 | 1 |
| PageSize | string | 否 | 分页查询时设置的每页行数。取值：>0，默认为 10。 | 10 |
| KeyPairId | string | 否 | 密钥对的 ID。 | ssh-50cynkq42sgj4ej1tn78t4*** |
返回参数
示例
正常返回示例
JSON格式
{
"KeyPairs": {
"KeyPair": [
{
"CreationTime": "2020-04-26T15:38:27Z",
"KeyPairFingerPrint": "fdaf8ff7a756ef843814fc****",
"KeyPairName": "TestKeyPairName",
"KeyPairId": "ssh-50cynkq42sgj4ej1tn78t4***"
}
]
},
"PageNumber": 1,
"PageSize": 10,
"RequestId": "37B52F33-6879-49D0-A39B-22966B01449E",
"TotalCount": 7
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
| 400 | NoPermission | Permission denied. | 没有足够的权限，请联系云账号管理员授予您相应权限。 |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
| 400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
| 400 | ens.interface.error | An error occurred while calling the API. | - |
| 400 | CallInterface | Call Interface Happen Error. | 接口调用出错。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-21 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |