面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/update-vault-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

更新保管库

POST https://ark.cn-beijing.volces.com/api/v3/vaults/{vault_id}

更新指定保管库的展示名称或自定义元数据。请求体为空,或者只传入空的 metadata 对象时,服务端返回当前保管库信息,不修改数据或更新时间。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。

请求参数#

Path 参数#

vault_id string 必选  |  保管库 ID

保管库 ID,以 vlt- 开头。

Body 参数#

display_name string  |  保管库展示名

保管库的展示名称,用于在保管库列表和详情中识别该保管库。省略时保留原值。

metadata object  |  自定义元数据

用于分类或关联业务信息的字符串键值对:

  • 省略或传入空对象时,保留全部原值。
  • 提供非空值时,新增或覆盖对应键。
  • 值为空字符串时,删除对应键。

更新后最多 16 对;键长度为 1~64 个字符,值最长 512 个字符。

响应参数#

created_at string  |  创建时间

保管库的创建时间,采用 RFC 3339 格式。

display_name string  |  保管库展示名

保管库的展示名称,用于识别该保管库。

id string  |  保管库 ID

保管库 ID,以 vlt- 开头。

type string  |  对象类型

表示当前对象是一个保管库。

取值固定为 vault。

updated_at string  |  更新时间

保管库最后一次更新的时间,采用 RFC 3339 格式。

metadata object  |  自定义元数据

为保管库设置的字符串键值对,可用于分类或关联业务信息。未设置时返回 null。