Skip to main content
Vault

更新 Vault

使用补丁语义更新 Vault 的名称或元数据。display_name 和 metadata 至少提供一个。

前提

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

接口

POST /vaults/{vault_id}

路径参数

参数必填类型说明
vault_idstringVault ID,格式 vlt_xxx

请求体

display_name 和 metadata 至少提供一个。
字段必填类型说明
display_namestring新的可读名称,1-255 字符
metadataobject补丁语义:键设为字符串则追加或覆盖,设为 null 则删除该键

请求示例

curl -X POST "$AGENTSTUDIO_URL/vaults/vlt_xxx" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "生产环境密钥箱(已更名)",
    "metadata": {
      "environment": "production",
      "deprecated_key": null
    }
  }'

响应

{
  "id": "vlt_xxx",
  "type": "vault",
  "display_name": "生产环境密钥箱(已更名)",
  "metadata": {
    "environment": "production"
  },
  "archived_at": null,
  "created_at": "2026-06-20T10:00:00Z",
  "updated_at": "2026-07-01T14:30:00Z"
}

响应字段

字段类型说明
idstringVault ID,格式 vlt_xxx
typestring固定为 vault
display_namestringVault 可读名称
metadataobject业务自定义键值对
archived_atstring | null归档时间,未归档时为 null
created_atstring创建时间,ISO 8601
updated_atstring最近更新时间,ISO 8601

错误码

状态码错误码说明
400InvalidParameterRequired parameter missing or invalid.
401InvalidApiKeyInvalid API-key provided.
Managed Agents
知识检索与问答
应用调用
框架