Modifying a Vault

Function

This API is used to modify a vault based on its ID.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Default value: N/A
vault_id	Yes	String	Vault ID. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
vault	Yes	VaultUpdate object	Parameters for modifying a vault.

**Table 4** VaultUpdate
Parameter	Mandatory	Type	Description
billing	No	BillingUpdate object	Bill information
name	No	String	Vault name. The value can contain a maximum of 64 characters, including letters, digits, underscores (_), and hyphens (-). Default value: N/A
auto_bind	No	Boolean	Whether automatic association is supported. Default value: false. The options are as follows: true: Automatic association is supported. false: Automatic association is not supported.
bind_rules	No	VaultBindRules object	Association rule
auto_expand	No	Boolean	Whether to enable automatic capacity expansion. The default value is false. The value can be true (supporting automatic capacity expansion) or false (not supporting automatic capacity expansion.
smn_notify	No	Boolean	Whether to send SMN notifications. The default value is true. The options are as follows: true: SMN notifications will be sent. false: SMN notifications will not be sent.
threshold	No	Integer	Vault capacity threshold. If the vault usage exceeds this threshold and smn_notify is true, a notification will be sent. Range: 1 to 100. The default value is 80.

**Table 5** BillingUpdate
Parameter	Mandatory	Type	Description
size	No	Integer	Vault size (GB). Range: [10,10485760]; Default value: N/A

**Table 6** VaultBindRules
Parameter	Mandatory	Type	Description
tags	No	Array of BindRulesTags objects	Resources automatically filtered by tag. Minimum length: 0 characters Maximum length: 5 characters

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
vault	Vault object	Objects returned after a vault query

**Table 8** Vault
Parameter	Type	Description
billing	Billing object	Operation info
description	String	Custom description of the vault. The value cannot contain angle brackets (< or >) and can contain a maximum of 255 characters.
id	String	Vault ID. Range: N/A
name	String	Vault name. The value can contain a maximum of 64 characters, including letters, digits, underscores (_), and hyphens (-).
project_id	String	Project ID.
provider_id	String	Vault resource type. The value can be: 0daac4c5-6707-4851-97ba-169e36266b66: cloud server d1603440-187d-4516-af25-121250c7cc97: EVS disk 3f3c3220-245c-4805-b811-758870015881, SFS Turbo
resources	Array of ResourceResp objects	Vault resources
tags	Array of Tag objects	Vault tags
auto_bind	Boolean	Whether automatic association is supported. The value can be: true: Automatic association is supported. false: Automatic association is not supported.
bind_rules	VaultBindRules object	Association rule
user_id	String	User ID
created_at	String	Creation time, for example, 2020-02-05T10:38:34.209782
auto_expand	Boolean	Whether to enable automatic capacity expansion. The value can be true (supporting automatic capacity expansion) or false (not supporting automatic capacity expansion.
sys_lock_source_service	String	SMB identifier. The value can be SMB or an empty string. SMB: CBR is called as a service for SMB. An empty string: CBR is called as a common service.
availability_zone	String	Availability zone of the vault. The value can contain a maximum of 32 characters.

**Table 9** Billing
Parameter	Type	Description
allocated	Integer	Allocated capacity, in GB. Range: 10 to 10485760
charging_mode	String	Billing mode. Currently, only post_paid is supported, indicating pay-per-use billing mode.
cloud_type	String	Cloud type. The following types are supported: public: public cloud
consistent_level	String	Vault specifications. crash_consistent: crash consistency.
object_type	String	Object type. The value can be server, disk, or turbo. server: cloud server; disk: EVS disk; turbo: file system
order_id	String	Order ID, in UUID format.
product_id	String	Product ID, in UUID format.
protect_type	String	Protection type. The value can be: backup
size	Integer	Capacity, in GB. Range: 10 to 10485760
spec_code	String	Specification code. The value can be: Server backup vault: vault.backup.server.normal; Disk backup vault: vault.backup.volume.normal; File system backup vault: vault.backup.turbo.normal
status	String	Vault status. The value can be: available: The vault is available. lock: The vault is locked. frozen: The vault is frozen. deleting: The vault is being deleted. error: The vault is abnormal.
storage_unit	String	Bucket name. Range: N/A
used	Integer	Used capacity, in MB. Range: N/A
frozen_scene	String	Freezing scenario. The value can be: POLICE: The account is frozen for public security. ARREAR: The account is frozen because it is in arrears. ILLEGAL: The account is frozen due to violation of laws and regulations. VERIFY: The account has not completed real-name authentication. DELETE_ACCOUNT: The account is deleted after unsubscription.

**Table 10** ResourceResp
Parameter	Type	Description
id	String	ID of the resource to be backed up. The resource must have been associated with the vault and can be backed up.
name	String	Name of the resource to be backed up. The value can contain a maximum of 255 characters.
protect_status	String	Protection status. The value can be: available: The resource is available. error: The resource is abnormal. protecting: The resource is being protected. restoring: The resource is being restored. removing: The resource is being removed.
size	Integer	Allocated capacity for the associated resources, in GB. Range: N/A
type	String	Type of the resource to be backed up: OS::Nova::Server: ECS; OS::Cinder::Volume: EVS disks; OS::Sfs::Turbo: SFS Turbo file systems
backup_size	Integer	Backup replica size in GB. Range: N/A
backup_count	Integer	Number of replicas. Range: N/A

**Table 11** VaultBindRules
Parameter	Type	Description
tags	Array of BindRulesTags objects	Resources automatically filtered by tag. Minimum length: 0 characters Maximum length: 5 characters

Example Requests

Modifying a vault (vault capacity changed to 200 GB and vault name changed to vault_name02)

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

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

Example Responses

Status code: 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"
  }
}