Skip to main content
Credential

归档 Credential

归档指定 Credential,归档后 Credential 不再注入会话,但仍可查询和恢复。响应中 archived_at 字段已设置归档时间。

前提

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

接口

POST /credentials/{credential_id}/archive

路径参数

参数必填类型说明
credential_idstringCredential ID,格式 cred_xxx

请求示例

curl -X POST "$AGENTSTUDIO_URL/credentials/cred_xxx/archive" \
  -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": {
      "type": "unrestricted"
    }
  },
  "metadata": {},
  "archived_at": "2026-07-15T06:00:00Z",
  "created_at": "2026-07-10T08:00:00Z",
  "updated_at": "2026-07-15T06:00:00Z",
  "request_id": "req_xxx"
}

响应字段

字段类型说明
idstringCredential ID,格式 cred_xxx
typestring固定为 credential
vault_idstring所属 Vault ID
display_namestringCredential 可读名称
authobject认证信息,敏感值已脱敏
metadataobject业务自定义键值对
archived_atstring归档时间,ISO 8601
created_atstring创建时间,ISO 8601
updated_atstring最近更新时间,ISO 8601
request_idstring请求唯一标识

错误码

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