文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 管理SSH密钥对/ 密钥对管理/ 查询SSH密钥对列表
更新时间：2025-09-18 GMT+08:00
查看PDF
分享

查询SSH密钥对列表

功能介绍

查询SSH密钥对列表

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/keypairs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

每页返回的个数。

默认值：50。

marker

否

String

分页查询起始的资源id，为空时为查询第一页

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

keypairs

Array of Keypairs objects

SSH密钥对信息列表

page_info

PageInfo object

分页信息
表5 Keypairs

参数

参数类型

描述

keypair

Keypair object

密钥对信息
表6 Keypair

参数

参数类型

描述

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

冻结状态

  • 0：正常状态

  • 1：普通冻结

  • 2：公安冻结

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

  • 4：违规冻结

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

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

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

  • 8：未实名认证冻结

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

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

参数

参数类型

描述

next_marker

String

返回下一页的查询地址

previous_marker

String

返回上一页的查询地址

current_count

Integer

返回条目数量

状态码：400

表8 响应Body参数

参数

参数类型

描述

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

错误码

请参见错误码。

父主题： 密钥对管理

相关文档