ListUserSSHKeys - 查询指定用户 SSH Key 列表_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI 查询指定用户 SSH Key 列表。

适用版本

企业标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。

产品	资源	所需权限
代码管理	SSH密钥	只读

请求语法

GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/users/{userId}/keys

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	组织 ID。	60d54f3daccf2bbd6659f3ad
userId	string	path	是	用户 ID。	60d54f3ddbbd661659f3ad
page	integer	query	否	页码，默认从1开始，一般不要超过150页。	1
perPage	integer	query	否	每页大小，默认20，取值范围【1，100】。	20
orderBy	string	query	否	排序字段，可选值包括 {created_at, updated_at}，默认值为 created_at。	created_at
sort	string	query	否	排序方式，可选值包括{asc, desc}，默认值为 desc。	desc

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/users/60d54f3ddbbd661659f3ad/keys?page=1&perPage=20&orderBy=created_at&sort=desc' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	object
createdAt	string	创建时间。	2024-10-05T15:30:45Z
expireTime	string	过期时间。	2024-10-05T15:30:45Z
fingerPrint	string	指纹信息。	xxx
id	integer	SSH Key 的主键 ID。	1
key	string	SSH Key 的公钥串。	xxx
keyScope	string	作用范围: ALL - 全部（读/写操作，包括 clone/pull/push），READ - 只读（仅支持 clone/pull）。	ALL
lastUsedTime	string	最后使用时间。	2024-10-05T15:30:45Z
title	string	SSH Key 的标题。	username@example
updatedAt	string	更新时间。	2024-10-05T15:30:45Z

返回示例

{
    "createdAt": "2024-10-05T15:30:45Z",
    "expireTime": "2024-10-05T15:30:45Z",
    "fingerPrint": "xxx",
    "id": 1,
    "key": "xxx",
    "keyScope": "ALL",
    "lastUsedTime": "2024-10-05T15:30:45Z",
    "title": "username@example",
    "updatedAt": "2024-10-05T15:30:45Z"
}

响应头

参数	描述	示例值
x-next-page	下一页。	3
x-page	当前页。	2
x-per-page	每页大小。	20
x-prev-page	前一页。	1
x-request-id	请求 ID。	37294673-00CA-5B8B-914F-A8B35511E90A
x-total	总数。	50
x-total-pages	总分页数。	3

错误码

访问错误码中心查看 API 相关错误码。