華為云計算 云知識 修改存儲庫UpdateVault
修改存儲庫UpdateVault

 

功能介紹

根據(jù)存儲庫ID修改存儲庫

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID

vault_id

String

存儲庫ID

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過調(diào)用 IAM 服務獲取用戶Token接口獲?。憫㈩^中X-Subject-Token的值)。

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

vault

VaultUpdate object

存儲庫修改參數(shù)體

表4 VaultUpdate

參數(shù)

是否必選

參數(shù)類型

描述

billing

BillingUpdate object

賬單信息

name

String

存儲庫名稱

最小長度:1

最大長度:64

auto_bind

Boolean

是否支持自動掛載

bind_rules

VaultBindRules object

綁定規(guī)則

auto_expand

Boolean

是否開啟存儲庫自動擴容能力(只支持按需存儲庫)。

smn_notify

Boolean

發(fā)送smn通知開關

缺省值:true

threshold

Integer

存儲庫容量閾值,存儲庫已用容量和總容量的百分比超過該值,若smn_notify為開,將發(fā)送相關通知。

最小值:1

最大值:100

缺省值:80

表5 BillingUpdate

參數(shù)

是否必選

參數(shù)類型

描述

consistent_level

String

存儲庫規(guī)格

枚舉值:

  • app_consistent

  • crash_consistent

size

Integer

存儲庫大小,單位為GB

最小值:1

最大值:10485760

表6 VaultBindRules

參數(shù)

是否必選

參數(shù)類型

描述

tags

Array of BindRulesTags objects

按tags過濾自動綁定的資源

最小長度:0

最大長度:5

數(shù)組長度:0 - 5

表7 BindRulesTags

參數(shù)

是否必選

參數(shù)類型

描述

key

String

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,數(shù)字,“-”,“_”組成。

value

String

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,數(shù)字,“-”,“_”,“.”組成。

響應參數(shù)

狀態(tài)碼: 200

表8 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

vault

Vault object

存儲庫查詢返回對象

表9 Vault

參數(shù)

參數(shù)類型

描述

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 ResourceResp objects

存儲庫資源

tags

Array of Tag objects

存儲庫標簽

enterprise_project_id

String

企業(yè)項目id,默認為‘0’。

auto_bind

Boolean

是否自動綁定,默認為false,不支持。

bind_rules

VaultBindRules object

綁定規(guī)則

user_id

String

用戶id

created_at

String

創(chuàng)建時間,例如:"2020-02-05T10:38:34.209782"

auto_expand

Boolean

是否開啟存儲庫自動擴容能力(只支持按需存儲庫)。

smn_notify

Boolean

存儲庫smn 消息通知 開關

缺省值:true

threshold

Integer

存儲庫容量閾值,已用容量占總容量達到此百分比即發(fā)送相關通知

最小值:1

最大值:100

缺省值:80

表10 Billing

參數(shù)

參數(shù)類型

描述

allocated

Integer

已分配容量,單位GB

charging_mode

String

創(chuàng)建模式,按需:post_paid,包周期:pre_paid,默認為post_paid

cloud_type

String

公有云:public ;混合云:hybrid

consistent_level

String

規(guī)格,崩潰一致性(crash_consistent)或應用一致性(app_consistent)

object_type

String

對象類型: 云服務器 (server), 云硬盤 (disk),文件系統(tǒng)(turbo), 云桌面 (workspace),VMware(vmware),關系型 數(shù)據(jù)庫 (rds),文件(file)。

order_id

String

訂單ID

product_id

String

產(chǎn)品ID

protect_type

String

保護類型:備份(backup)、復制(replication)。

size

Integer

容量,單位GB

最小值:1

最大值:10485760

spec_code

String

規(guī)格編碼。 云服務備份存儲庫:vault.backup.server.normal; 云硬盤備份 存儲庫:vault.backup.volume.normal;文件備份存儲庫:vault.backup.turbo.normal

status

String

存儲庫狀態(tài)

枚舉值:

  • available

  • lock

  • frozen

  • deleting

  • error

storage_unit

String

存儲庫桶名

used

Integer

已使用容量,單位MB

frozen_scene

String

凍結場景

表11 ResourceResp

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱

最小長度:0

最大長度:255

protect_status

String

保護狀態(tài)

枚舉值:

  • 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

副本數(shù)量

表12 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

需要排除備份的卷id。僅在多盤備份特性中有效,排除不需要備份的磁盤。當虛擬機新綁定磁盤時,也能繼續(xù)排除之前設置不用備份的卷。

表13 Tag

參數(shù)

參數(shù)類型

描述

key

String

鍵。

key最大長度為36個字符。

key不能為空字符串。

key前后空格會被丟棄。

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,數(shù)字,“-”,“_”組成。

value

String

值。

添加標簽時value值必選,刪除標簽時value值可選。

value最大長度為43個字符。

value可以為空字符串。

value前后的空格會被丟棄。

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,數(shù)字,“-”,“_”,“.”組成。

表14 VaultBindRules

參數(shù)

參數(shù)類型

描述

tags

Array of BindRulesTags objects

按tags過濾自動綁定的資源

最小長度:0

最大長度:5

數(shù)組長度:0 - 5

表15 BindRulesTags

參數(shù)

參數(shù)類型

描述

key

String

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,數(shù)字,“-”,“_”組成。

value

String

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,數(shù)字,“-”,“_”,“.”組成。

請求示例

修改一個存儲庫,容量為200G,名稱為vault_name02。

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

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

響應示例

狀態(tài)碼: 200

OK

{
  "vault" : {
    "name" : "vault_name02",
    "billing" : {
      "status" : "available",
      "used" : 0,
      "protect_type" : "backup",
      "order_id" : null,
      "object_type" : "server",
      "allocated" : 40,
      "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"
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。