修改存储库

功能介绍

根据存储库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	存储库名称
auto_bind	否	Boolean	是否支持自动挂载
bind_rules	否	VaultBindRules object	绑定规则
auto_expand	否	Boolean	是否开启存储库自动扩容能力（只支持按需存储库）。
smn_notify	否	Boolean	发送smn通知开关
threshold	否	Integer	存储库容量阈值，存储库已用容量和总容量的百分比超过该值，如果smn_notify为开，将发送相关通知。
locked	否	Boolean	用于标识当前存储库是否已锁定，锁定的存储库不支持解锁。

表5 BillingUpdate
参数	是否必选	参数类型	描述
consistent_level	否	String	存储库规格 app_consistent: 应用一致性 crash_consistent: 崩溃一致性
size	否	Integer	存储库大小，单位为GB

表6 VaultBindRules
参数	是否必选	参数类型	描述
tags	否	Array of BindRulesTags objects	按tags过滤自动绑定的资源最小长度：0 最大长度：5

表7 BindRulesTags
参数	是否必选	参数类型	描述
key	是	String	key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。 key只能由中文，字母，数字，“-”，“_”组成。
value	是	String	value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。 value只能由中文，字母，数字，“-”，“_”，“.”组成。

响应参数

状态码： 200

表8 响应Body参数
参数	参数类型	描述
vault	Vault object	存储库查询返回对象

表9 Vault
参数	参数类型	描述
billing	Billing object	运营信息
description	String	存储库自定义描述信息。
id	String	存储库ID
name	String	存储库名称
project_id	String	项目ID
provider_id	String	存储库资源类型id
resources	Array of ResourceResp objects	存储库资源
tags	Array of Tag objects	存储库标签
enterprise_project_id	String	企业项目id，默认为‘0’。
auto_bind	Boolean	是否自动绑定，默认为false，不支持。
bind_rules	VaultBindRules object	绑定规则
user_id	String	用户id
created_at	String	创建时间,例如:"2020-02-05T10:38:34.209782"
auto_expand	Boolean	是否开启存储库自动扩容能力（只支持按需存储库）。
smn_notify	Boolean	存储库smn消息通知开关
threshold	Integer	存储库容量阈值，已用容量占总容量达到此百分比即发送相关通知
sys_lock_source_service	String	用于标识SMB服务，您可以设置为SMB或者空
locked	Boolean	用于标识当前存储库是否已锁定，锁定的存储库不支持解锁。

**表10** Billing
参数	参数类型	描述
allocated	Integer	已分配容量，单位GB
charging_mode	String	创建模式，按需：post_paid，包周期：pre_paid，默认为post_paid
cloud_type	String	公有云:public ;混合云:hybrid
consistent_level	String	规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent）
object_type	String	对象类型：云服务器（server），云硬盘（disk），文件系统（turbo），云桌面（workspace），VMware（vmware），关系型数据库（rds），文件（file）。
order_id	String	订单ID
product_id	String	产品ID
protect_type	String	保护类型：备份（backup）、复制(replication)。
size	Integer	容量，单位GB
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	冻结场景
is_multi_az	Boolean	存储库多az属性

**表11** ResourceResp
参数	参数类型	描述
extra_info	ResourceExtraInfo object	资源附加信息
id	String	待备份资源id
name	String	待备份资源名称
protect_status	String	保护状态 available: 可用 error: 异常 protecting: 保护中 restoring: 恢复中 removing: 删除中
size	Integer	资源已分配容量,单位为GB
type	String	待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2
backup_size	Integer	副本大小
backup_count	Integer	副本数量

**表12** ResourceExtraInfo
参数	参数类型	描述
exclude_volumes	Array of strings	需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。

**表13** Tag
参数	参数类型	描述
key	String	键。 key最大长度为36个字符。 key不能为空字符串。 key前后空格会被丢弃。 key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。 key只能由中文，字母，数字，“-”，“_”组成。
value	String	值。添加标签时value值必选，删除标签时value值可选。 value最大长度为43个字符。 value可以为空字符串。 value前后的空格会被丢弃。 value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。 value只能由中文，字母，数字，“-”，“_”，“.”组成。

**表14** VaultBindRules
参数	参数类型	描述
tags	Array of BindRulesTags objects	按tags过滤自动绑定的资源最小长度：0 最大长度：5

**表15** BindRulesTags
参数	参数类型	描述
key	String	key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。 key只能由中文，字母，数字，“-”，“_”组成。
value	String	value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“\|”,“/”。 value只能由中文，字母，数字，“-”，“_”，“.”组成。

请求示例

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

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

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

响应示例

状态码： 200

{
  "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

错误码

请参见错误码。

父主题： 存储库

上一篇：查询存储库列表

下一篇：删除存储库

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消