4.4 存储库
4.4.4 修改存储库
功能介绍
根据存储库ID修改存储库
调试
您可以在API Explorer中调试该接口。
URI
PUT /v3/{project_id}/vaults/{vault_id}
表4-151 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
vault_id 是 String 存储库ID
请求参数
表4-152 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。 通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)。
表4-153 请求 Body 参数
参数 是否必选 参数类型 描述
vault 是 VaultUpdate
object 存储库修改参数体
表4-154 VaultUpdate
参数 是否必选 参数类型 描述
billing 否 BillingUpdat
e object 账单信息
name 否 String 存储库名称
最小长度:1 最大长度:64
auto_bind 否 Boolean 是否支持自动挂载
bind_rules 否 VaultBindRul es object
auto_expand 否 Boolean 是否开启存储库自动扩容能力
(只支持按需存储库)。
smn_notify 否 Boolean 发送smn通知开关 缺省值:true
threshold 否 Integer 存储库容量阈值,存储库已用容
量和总容量的百分比超过该值,
若smn_notify为开,将发送相关 通知。
最小值:1 最大值:100 缺省值:80
表4-155 BillingUpdate
参数 是否必选 参数类型 描述
consistent_lev
el 否 String 存储库规格
枚举值:
● app_consistent
● crash_consistent
参数 是否必选 参数类型 描述
size 否 Integer 存储库大小,单位为GB
最小值:1
最大值:10485760
表4-156 VaultBindRules
参数 是否必选 参数类型 描述
tags 否 Array of Tag
objects 按tags过滤自动绑定的资源
表4-157 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只能由中文,字母,数 字,“-”,“_”,“.”组成。
响应参数
状态码: 200
表4-158 响应 Body 参数
参数 参数类型 描述
vault Vault object 存储库查询返回对象
表4-159 Vault
参数 参数类型 描述
billing Billing object 运营信息
description String 存储库自定义描述信息。
最小长度:0 最大长度:255
id String 存储库ID
name String 存储库名称
最小长度:1 最大长度:64 project_id String 项目ID
provider_id String 存储库资源类型id resources Array of
ResourceRes p objects
存储库资源
tags Array of Tag
objects 存储库标签 enterprise_pro
ject_id String 企业项目id,默认为‘0’。
auto_bind Boolean 是否自动绑定,默认为false,不支持。
bind_rules VaultBindRul
es object 绑定规则 user_id String 用户id
created_at String 创建时间,例如:"2020-02-05T10:38:34.209782"
auto_expand Boolean 是否开启存储库自动扩容能力(只支持按需存储 库)。
smn_notify Boolean 存储库smn消息通知开关 缺省值:true
参数 参数类型 描述
threshold Integer 存储库容量阈值,已用容量占总容量达到此百分 比即发送相关通知
最小值:1 最大值:100 缺省值:80
表4-160 Billing
参数 参数类型 描述
allocated Integer 已分配容量,单位GB charging_mod
e String 创建模式,按需:post_paid,包周期:
pre_paid,默认为post_paid cloud_type String 公有云:public ;混合云:hybrid consistent_lev
el String 规格,崩溃一致性(crash_consistent)或应用一 致性(app_consistent)
object_type String 对象类型:云服务器(server),云硬盘
(disk),文件系统(turbo)。
order_id String 订单ID product_id String 产品ID
protect_type String 保护类型:备份(backup)、复制 (replication)。
size Integer 容量,单位GB
最小值:1
最大值: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 冻结场景
表4-161 ResourceResp
参数 参数类型 描述
extra_info ResourceExtr
aInfo object 资源附加信息
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::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo
backup_size Integer 副本大小 backup_count Integer 副本数量
表4-162 ResourceExtraInfo
参数 参数类型 描述
include_volu
mes Array of ResourceExtr aInfoInclude Volumes objects
指定需要备份的卷,若有指定值,则每次备份都只 备份指定的卷,如虚拟机绑定存储库之后新绑定 的卷不会备份;若为空默认为资源全部卷;仅虚 拟机磁盘级备份特性中有效。
表4-163 ResourceExtraInfoIncludeVolumes
参数 参数类型 描述
id String 卷ID,仅支持uuid
os_version String 操作系统类型
表4-164 VaultBindRules
参数 参数类型 描述
tags Array of Tag
objects 按tags过滤自动绑定的资源
表4-165 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只能由中文,字母,数字,“-”,“_”,
“.”组成。
请求示例
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" : {
"spec_code" : "vault.backup.server.normal", "size" : 200,
"cloud_type" : "public", "product_id" : null,
"consistent_level" : "crash_consistent", "storage_unit" : null,
"charging_mode" : "post_paid"
}, "tags" : [ {
"value" : "value01", "key" : "key01"
} ],
"created_at" : "2019-05-08T09:31:21.840431", "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"
}}