获取 Credential

更新时间:
复制 MD 格式

获取指定 Credential 的详情。响应为 Credential 对象,auth 中的敏感值已脱敏。

前提

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

接口

GET /vaults/{vault_id}/credentials/{credential_id}

路径参数

参数必填类型说明
vault_id是stringVault ID,格式 vlt_xxx
credential_id是stringCredential ID,格式 cred_xxx

请求示例

curl "$AGENTSTUDIO_URL/vaults/vlt_xxx/credentials/cred_xxx" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

响应

{
  "id": "cred_xxx",
  "type": "credential",
  "vault_id": "vlt_xxx",
  "display_name": "第三方 API 密钥",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "networking": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-07-10T08:00:00Z",
  "updated_at": "2026-07-10T08:00:00Z",
  "request_id": "req_xxx"
}

响应字段

字段类型说明
idstringCredential ID,格式 cred_xxx
typestring固定为 credential
vault_idstring所属 Vault ID
display_namestringCredential 可读名称
authobject认证信息,敏感值已脱敏(如 secret_value 不返回)
auth.typestring认证类型,当前仅支持 environment_variable
auth.secret_namestring环境变量名称
auth.networkingobject网络策略
auth.networking.allowed_hostsarray允许替换真实密钥的域名列表
auth.injection_locationobject替换位置。当前仅支持 Authorization 请求头,写入请求体暂不支持
auth.injection_location.headerboolean是否写入 Authorization 请求头
metadataobject业务自定义键值对
archived_atstring | null归档时间,未归档时为 null
created_atstring创建时间,ISO 8601
updated_atstring最近更新时间,ISO 8601
request_idstring请求唯一标识

错误码

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