文档首页/ 密码安全中心 DEW/ API参考/ API说明/ 管理SSH密钥对/ 密钥对管理/ 查询SSH密钥对详细信息 - ListKeypairDetail
更新时间：2025-10-16 GMT+08:00
查看PDF
分享

查询SSH密钥对详细信息 - ListKeypairDetail

功能介绍

查询SSH密钥对详细信息

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kps:SSHKeyPair:get

    Read

    SSHKeyPair *

    -
    • kps:domainKeypairs:get

    -

URI

GET /v3/{project_id}/keypairs/{keypair_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

keypair_name

是

String

密钥对名称

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

keypair

KeypairDetail object

密钥对详细信息
表4 KeypairDetail

参数

参数类型

描述

name

String

SSH密钥对的名称

id

Long

SSH密钥对的ID

type

String

SSH密钥对的类型。ssh或x509。

scope

String

租户级或者用户级。domain或user。

public_key

String

SSH密钥对对应的publicKey信息

fingerprint

String

SSH密钥对应指纹信息

is_key_protection

Boolean

是否托管密钥

deleted

Boolean

SSH密钥对删除的标记

description

String

SSH密钥对的描述信息

user_id

String

SSH密钥对所属的用户信息

create_time

Long

SSH密钥对创建的时间，时间戳，即从1970年1月1日至该时间的总秒数

delete_time

Long

SSH密钥对删除的时间，时间戳，即从1970年1月1日至该时间的总秒数

update_time

Long

SSH密钥对的更新时间，时间戳，即从1970年1月1日至该时间的总秒数

frozen_state

Integer

冻结状态

  • 0：正常状态

  • 1：普通冻结

  • 2：公安冻结

  • 3：普通冻结及公安冻结

  • 4：违规冻结

  • 5：普通冻结及违规冻结

  • 6：公安冻结及违规冻结

  • 7：普通冻结、公安冻结及违规冻结

  • 8：未实名认证冻结

  • 9：普通冻结及未实名认证冻结

  • 10：公安冻结及未实名认证冻结

key_id

String

密钥ID。

algorithm

String

生成算法。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

请求已成功

{
  "keypair" : {
    "name" : "1hprr3TI",
    "id" : 116248,
    "type" : "ssh",
    "scope" : "user",
    "public_key" : "ssh-rsa AAAGenerated-by-Nova",
    "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0",
    "is_key_protection" : false,
    "deleted" : false,
    "description" : "12345",
    "user_id" : "6c2a33b1b8474d0dbac0a24297127525",
    "create_time" : 1581507580000,
    "delete_time" : null,
    "update_time" : null,
    "frozen_state" : 0
  }
}

状态码：400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

200

请求已成功

400

Error response

错误码

请参见错误码。

父主题： 密钥对管理