归档 Credential API：POST /vaults/{vault_id}/credentials/{credential_id}/archive-大模型服务平台百炼(Model Studio)-阿里云帮助中心

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

前提

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

接口

POST /vaults/{vault_id}/credentials/{credential_id}/archive

路径参数

参数	必填	类型	说明
`vault_id`	是	string	Vault ID，格式 vlt_xxx
`credential_id`	是	string	Credential ID，格式 cred_xxx

请求示例

bash

curl -X POST "$AGENTSTUDIO_URL/vaults/vlt_xxx/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": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  },
  "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"
}

响应字段

字段	类型	说明
`id`	string	Credential ID，格式 cred_xxx
`type`	string	固定为 credential
`vault_id`	string	所属 Vault ID
`display_name`	string	Credential 可读名称
`auth`	object	认证信息，敏感值已脱敏
`metadata`	object	业务自定义键值对
`archived_at`	string	归档时间，ISO 8601
`created_at`	string	创建时间，ISO 8601
`updated_at`	string	最近更新时间，ISO 8601
`request_id`	string	请求唯一标识

错误码

状态码	错误码	说明
400	`InvalidParameter`	Required parameter missing or invalid.
401	`InvalidApiKey`	Invalid API-key provided.