查询SSH密钥对列表 - ListKeypairs
功能介绍
查询SSH密钥对列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
kps:SSHKeyPair:list
List
SSHKeyPair *
-
kps:domainKeypairs:list
-
URI
GET /v3/{project_id}/keypairs
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
limit | 否 | String | 每页返回的个数。 默认值：1000。 |
marker | 否 | String | 分页查询起始的资源id，为空时为查询第一页 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
name | String | SSH密钥对的名称 |
type | String | SSH密钥对的类型，值为“ssh”或“x509” |
scope | String | 租户级或者用户级。domain或user。 |
public_key | String | SSH密钥对对应的publicKey信息 |
fingerprint | String | SSH密钥对应指纹信息 |
is_key_protection | Boolean | 是否托管密钥 |
frozen_state | String | 冻结状态
|
参数 | 参数类型 | 描述 |
|---|---|---|
next_marker | String | 返回下一页的查询地址 |
previous_marker | String | 返回上一页的查询地址 |
current_count | Integer | 返回条目数量 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"keypairs" : [ {
"keypair" : {
"name" : "1hprr3TI",
"type" : "ssh",
"scope" : "user",
"public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABjV8GvwpSs.....",
"fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0",
"is_key_protection" : false,
"frozen_state" : 0
}
} ],
"page_info" : {
"next_marker" : "KeyPair-dxxx",
"previous_marker" : "KeyPair-xxxx",
"current_count" : 49
}
} 状态码：400
Error response
{
"error_code" : "KPS.XXX",
"error_msg" : "XXX"
} 状态码
状态码 | 描述 |
|---|---|
200 | 请求已成功 |
400 | Error response |
错误码
请参见错误码。
