文档首页/ 云备份 CBR/ API参考（联盟区域）/ API/ 存储库/ 修改存储库
更新时间：2026-01-09 GMT+08:00
查看PDF
分享

修改存储库

功能介绍

根据存储库ID修改存储库

URI

PUT /v3/{project_id}/vaults/{vault_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，默认取值不涉及。

vault_id

是

String

存储库ID，默认取值不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。默认取值不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

vault

是

VaultUpdate object

存储库修改参数体
表4 VaultUpdate

参数

是否必选

参数类型

描述

billing

否

BillingUpdate object

账单信息

name

否

String

存储库名称，最大支持64字符，只能由中文、字母、数字、“_”、“-”组成。默认取值不涉及。

auto_bind

否

Boolean

功能说明：是否支持自动挂载。默认为false。

取值范围：

  • true：支持自动挂载

  • false：不支持自动挂载

bind_rules

否

VaultBindRules object

绑定规则

auto_expand

否

Boolean

功能说明：是否开启存储库自动扩容能力，默认为false。取值范围：true：支持自动扩容；false：不支持自动扩容。

smn_notify

否

Boolean

功能说明：是否发送smn通知开关，默认为true

取值范围：

  • true：发送smn通知

  • false：不发送smn通知

threshold

否

Integer

功能说明：存储库容量阈值，存储库已用容量和总容量的百分比超过该值，如果smn_notify为开，将发送相关通知。

取值范围：[1, 100]，默认值为80。
表5 BillingUpdate

参数

是否必选

参数类型

描述

size

否

Integer

存储库大小，单位为GB。取值范围[10, 10485760]，默认取值不涉及。
表6 VaultBindRules

参数

是否必选

参数类型

描述

tags

否

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度：0

最大长度：5

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

vault

Vault object

存储库查询返回对象
表8 Vault

参数

参数类型

描述

billing

Billing object

运营信息

description

String

存储库自定义描述信息，不能包含“<”，“>”，最大支持255个字符。

id

String

存储库ID，取值范围不涉及。

name

String

存储库名称，最大支持64字符，只能由中文、字母、数字、“_”、“-”组成。

project_id

String

项目ID。

provider_id

String

存储库资源类型ID，取值范围如下：

0daac4c5-6707-4851-97ba-169e36266b66，云服务器。d1603440-187d-4516-af25-121250c7cc97，云硬盘。3f3c3220-245c-4805-b811-758870015881，SFS Turbo。

resources

Array of ResourceResp objects

存储库资源

tags

Array of Tag objects

存储库标签

auto_bind

Boolean

功能说明：是否支持自动挂载。

取值范围：

  • true：支持自动挂载

  • false：不支持自动挂载

bind_rules

VaultBindRules object

绑定规则

user_id

String

用户id

created_at

String

创建时间,例如:"2020-02-05T10:38:34.209782"

auto_expand

Boolean

功能说明：是否开启存储库自动扩容能力。取值范围：true：支持自动扩容；false：不支持自动扩容。

sys_lock_source_service

String

用于标识SMB服务，支持传入SMB和空。

SMB：标识为SMB服务调用

空字符串：表示为普通服务调用

availability_zone

String

存储库可用区信息，最大支持32字符。
表9 Billing

参数

参数类型

描述

allocated

Integer

已分配容量，单位GB。取值范围：10-10485760。

charging_mode

String

功能说明：计费模式。当前仅支持post_paid，代表按需计费模式。

cloud_type

String

云类型，支持类型如下。

public：公有云

consistent_level

String

功能描述：存储库规格。取值范围：crash_consistent: 崩溃一致性。

object_type

String

对象类型，支持"server", "disk"和"turbo"共三种。server：云服务器，disk：云硬盘，turbo：文件系统。

order_id

String

订单ID，UUID格式。

product_id

String

产品ID，UUID格式。

protect_type

String

保护类型，取值范围如下：

backup：备份

size

Integer

容量，单位GB。取值范围：10-10485760。

spec_code

String

规格编码，取值范围如下：

云服务备份存储库：vault.backup.server.normal；云硬盘备份存储库：vault.backup.volume.normal；文件备份存储库：vault.backup.turbo.normal

status

String

存储库状态，取值范围如下：

  • available: 可用

  • lock: 锁定

  • frozen: 冻结

  • deleting: 删除中

  • error: 异常

storage_unit

String

存储库桶名，取值范围不涉及。

used

Integer

已使用容量，单位MB，取值范围不涉及。

frozen_scene

String

冻结场景，取值范围如下：

  • POLICE：公安冻结场景

  • ARREAR：欠费场景

  • ILLEGAL：违规冻结场景

  • VERIFY：客户未实名认证冻结场景

  • DELETE_ACCOUNT：退订删除场景
表10 ResourceResp

参数

参数类型

描述

id

String

待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。

name

String

待备份资源名称，长度限制：0-255字符。

protect_status

String

保护状态，取值范围如下：

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

size

Integer

资源已分配容量，单位为GB，取值范围不涉及。

type

String

待备份资源的类型: OS::Nova::Server：云服务器；OS::Cinder::Volume：云硬盘；OS::Sfs::Turbo：SFS Turbo文件系统。

backup_size

Integer

备份副本大小。单位GB。取值范围不涉及。

backup_count

Integer

副本数量，取值范围不涉及。
表11 VaultBindRules

参数

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度：0

最大长度：5

请求示例

修改一个存储库，容量为200G，名称为vault_name02。

PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d

{
  "vault" : {
    "billing" : {
      "size" : 200
    },
    "name" : "vault_name02"
  }
}

响应示例

状态码：200

OK

{
  "vault" : {
    "name" : "vault_name02",
    "billing" : {
      "status" : "available",
      "used" : 0,
      "protect_type" : "backup",
      "object_type" : "server",
      "allocated" : 40,
      "spec_code" : "vault.backup.server.normal",
      "size" : 200,
      "cloud_type" : "public",
      "consistent_level" : "crash_consistent",
      "charging_mode" : "post_paid"
    },
    "tags" : [ {
      "value" : "value01",
      "key" : "key01"
    } ],
    "created_at" : "2019-05-08T09:31:21.840+00:00",
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
    "enterprise_project_id" : 0,
    "id" : "2402058d-8373-4b0a-b848-d3c0dfdc71a8",
    "resources" : [ {
      "name" : "ecs-1f0f-0003",
      "protect_status" : "available",
      "extra_info" : {
        "exclude_volumes" : [ "bdef09bb-293f-446a-88a4-86e9f14408c4" ]
      },
      "type" : "OS::Nova::Server",
      "id" : "97595625-198e-4e4d-879b-9d53f68ba551",
      "size" : 40
    } ],
    "description" : "vault_description"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 存储库