Skip to main content
Credential

列出 Credential

分页列出指定 Vault 下的所有 Credential。

前提

已完成 Endpoint 与鉴权配置,详见API 总览与认证

接口

GET /credentials

Query 参数

参数必填类型说明
vault_idstringVault ID,格式 vlt_xxx
include_archivedboolean是否包含已归档的 Credential,默认 false
limitinteger每页返回数量,默认 20,最大 100
pagestring分页游标,从上一次响应的 next_page 获取

请求示例

curl "$AGENTSTUDIO_URL/credentials?vault_id=vlt_xxx&include_archived=true&limit=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

响应

响应包含 data(密钥对象数组)与 next_page(下一页游标,无更多数据时为 null)。
{
  "data": [
    {
      "id": "cred_xxx",
      "type": "credential",
      "vault_id": "vlt_xxx",
      "display_name": "第三方 API 密钥",
      "auth": {
        "type": "environment_variable",
        "secret_name": "API_KEY",
        "networking": {
          "type": "unrestricted"
        }
      },
      "metadata": {},
      "archived_at": null,
      "created_at": "2026-07-10T08:00:00Z",
      "updated_at": "2026-07-10T08:00:00Z",
      "request_id": "req_xxx"
    }
  ],
  "next_page": null
}

响应字段

字段类型说明
dataarray<object>Credential 对象数组
data[].idstringCredential ID,格式 cred_xxx
data[].typestring固定为 credential
data[].vault_idstring所属 Vault ID
data[].display_namestringCredential 可读名称
data[].authobject认证信息,敏感值已脱敏
data[].metadataobject业务自定义键值对
data[].archived_atstring | null归档时间,未归档时为 null
data[].created_atstring创建时间,ISO 8601
data[].updated_atstring最近更新时间,ISO 8601
data[].request_idstring请求唯一标识
next_pagestring | null下一页游标,无更多数据时为 null

错误码

状态码错误码说明
400InvalidParameterRequired parameter missing or invalid.
401InvalidApiKeyInvalid API-key provided.