文档

ListUserKeys - 查询SSH密钥列表

更新时间:

查询当前用户的SSH密钥列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v3/user/keys

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
pagelong

页码,默认值为 1

1
pageSizelong

每页大小,默认值为 20,取值范围【1,100】

10
sortstring

排序方式,默认值为 desc

  • asc:按排序字段升序排序

  • desc:按排序字段降序排序

desc
orderBystring

排序字段,默认值为 created_at

  • created_at:创建时间

  • updated_at:更新时间

created_at

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

F7B85D1B-D1C2-140F-A039-341859F130B9
errorCodestring

错误码

Openapi.RequestError
errorMessagestring

错误信息

Openapi.RequestError
successboolean

调用是否成功

true
resultarray<object>

返回结果列表

object

返回结果

idlong

SSH 密钥的主键 ID

5240
titlestring

SSH 密钥的标题

My Title
publicKeystring

SSH-Key 的公钥串

xxx
fingerPrintstring

指纹信息

xxx
keyScopestring

作用范围,可选值:ALL、READ

  • ALL:全部(读/写操作包括 clone/pull/push 等)

  • READ:只读(仅支持 clone/pull )

ALL
createdAtstring

创建时间

2022-03-18 14:24:54
expireTimestring

过期时间

2022-03-18 14:24:54
lastUsedTimestring

上次使用时间

2022-03-18 14:24:54

示例

正常返回示例

JSON格式

{
  "requestId": "F7B85D1B-D1C2-140F-A039-341859F130B9",
  "errorCode": "Openapi.RequestError",
  "errorMessage": "Openapi.RequestError",
  "success": true,
  "result": [
    {
      "id": 5240,
      "title": "My Title",
      "publicKey": "xxx",
      "fingerPrint": "xxx",
      "keyScope": "ALL",
      "createdAt": "2022-03-18 14:24:54",
      "expireTime": "2022-03-18 14:24:54",
      "lastUsedTime": "2022-03-18 14:24:54"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-01OpenAPI 返回结构发生变更查看变更详情