Querying a Specified Vault

Function

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

URI

GET /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

Response Parameters

Status code: 200

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

**Table 4** 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
enterprise_project_id	String	Enterprise project ID.
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 (supported for pay-per-use vaults only). The value can be true or false. true: Automatic capacity expansion is supported. false: Automatic capacity expansion is not supported.
smn_notify	Boolean	Whether to send SMN notifications. The value can be: true: SMN notifications will be sent. false: SMN notifications will not be sent.
threshold	Integer	Vault capacity threshold. If the vault usage exceeds this threshold and smn_notify is true, a notification will be sent. Range: [1,100]
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 5** Billing
Parameter	Type	Description
allocated	Integer	Allocated capacity, in GB. Range: 10 to 10485760
charging_mode	String	Billing mode. post_paid: pay-per-use; pre_paid: yearly/monthly
cloud_type	String	Cloud type. The following types are supported: public: public cloud; hybrid: hybrid cloud
consistent_level	String	Vault specifications. app_consistent: application consistency; 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 or replication
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 6** ResourceResp
Parameter	Type	Description
extra_info	ResourceExtraInfo object	Extra information of the resource
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::Ironic::BareMetalServer: Bare Metal Servers; OS::Sfs::Turbo: SFS Turbo file systems; OS::Workspace::DesktopV2: Workspaces
backup_size	Integer	Backup replica size in GB. Range: N/A
backup_count	Integer	Number of replicas. Range: N/A

**Table 7** ResourceExtraInfo
Parameter	Type	Description
exclude_volumes	Array of strings	ID of the volume that does not need to be backed up. This parameter is valid only for multi-disk backup. It specifies the disks that do not need to be backed up. When a disk is newly attached to a VM, the volume that does not need to be backed up can also be excluded. Default value: N/A
include_volumes	Array of ResourceExtraInfoIncludeVolumes objects	Volumes that need to be backed up. If this parameter is specified, only the specified volumes will be backed up. For example, if new volumes are added to a server after the server is associated with a vault, these new volumes will not be backed up. If this parameter is not specified, all volumes on the server will be backed up. This parameter takes effect only for disk-level backup. Default value: N/A

**Table 8** ResourceExtraInfoIncludeVolumes
Parameter	Type	Description
id	String	Volume ID in UUID format. Default value: N/A
os_version	String	OS type. Default value: N/A

**Table 9** Tag
Parameter	Type	Description
key	String	Tag key. Default value: N/A A tag key consists of up to 36 characters. It cannot be an empty string. Spaces before and after a key will be discarded. The key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores ().
value	String	Tag value. Default value: N/A It is mandatory when a tag is added and optional when a tag is deleted. It consists of up to 43 characters. It can be an empty string. Spaces before and after a value will be discarded. The value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). The value can contain only letters, digits, hyphens (-), underscores (), and periods (.).*

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

**Table 11** BindRulesTags
Parameter	Type	Description
key	String	The key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). Default value: N/A The key can contain only letters, digits, hyphens (-), and underscores ().
value	String	The value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). Default value: N/A The value can contain only letters, digits, hyphens (-), underscores (), and periods (.).*

Status code: 404

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

**Table 13** 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
enterprise_project_id	String	Enterprise project ID.
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 (supported for pay-per-use vaults only). The value can be true or false. true: Automatic capacity expansion is supported. false: Automatic capacity expansion is not supported.
smn_notify	Boolean	Whether to send SMN notifications. The value can be: true: SMN notifications will be sent. false: SMN notifications will not be sent.
threshold	Integer	Vault capacity threshold. If the vault usage exceeds this threshold and smn_notify is true, a notification will be sent. Range: [1,100]
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 14** Billing
Parameter	Type	Description
allocated	Integer	Allocated capacity, in GB. Range: 10 to 10485760
charging_mode	String	Billing mode. post_paid: pay-per-use; pre_paid: yearly/monthly
cloud_type	String	Cloud type. The following types are supported: public: public cloud; hybrid: hybrid cloud
consistent_level	String	Vault specifications. app_consistent: application consistency; 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 or replication
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 15** ResourceResp
Parameter	Type	Description
extra_info	ResourceExtraInfo object	Extra information of the resource
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::Ironic::BareMetalServer: Bare Metal Servers; 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 16** ResourceExtraInfo
Parameter	Type	Description
exclude_volumes	Array of strings	ID of the volume that does not need to be backed up. This parameter is valid only for multi-disk backup. It specifies the disks that do not need to be backed up. When a disk is newly attached to a VM, the volume that does not need to be backed up can also be excluded. Default value: N/A
include_volumes	Array of ResourceExtraInfoIncludeVolumes objects	Volumes that need to be backed up. If this parameter is specified, only the specified volumes will be backed up. For example, if new volumes are added to a server after the server is associated with a vault, these new volumes will not be backed up. If this parameter is not specified, all volumes on the server will be backed up. This parameter takes effect only for disk-level backup. Default value: N/A

**Table 17** ResourceExtraInfoIncludeVolumes
Parameter	Type	Description
id	String	Volume ID in UUID format. Default value: N/A
os_version	String	OS type. Default value: N/A

**Table 18** Tag
Parameter	Type	Description
key	String	Tag key. Default value: N/A A tag key consists of up to 36 characters. It cannot be an empty string. Spaces before and after a key will be discarded. The key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores ().
value	String	Tag value. Default value: N/A It is mandatory when a tag is added and optional when a tag is deleted. It consists of up to 43 characters. It can be an empty string. Spaces before and after a value will be discarded. The value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). The value can contain only letters, digits, hyphens (-), underscores (), and periods (.).*

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

**Table 20** BindRulesTags
Parameter	Type	Description
key	String	The key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). Default value: N/A The key can contain only letters, digits, hyphens (-), and underscores ().
value	String	The value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). Default value: N/A The value can contain only letters, digits, hyphens (-), underscores (), and periods (.).*

Example Requests

Querying a vault

GET https://{endpoint}/v3/{project_id}/vaults/{vault_id}

Example Responses

Status code: 200

{
  "vault" : {
    "id" : "2b076f26-391f-40fa-bf71-a798940faccf",
    "name" : "sdk-vault1595581958",
    "resources" : [ ],
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "created_at" : "2020-07-24T09:12:49.492+00:00",
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "enterprise_project_id" : 0,
    "auto_bind" : true,
    "bind_rules" : { },
    "auto_expand" : false,
    "user_id" : "aa2999fa5ae640f28926f8fd79188934",
    "billing" : {
      "allocated" : 0,
      "cloud_type" : "public",
      "consistent_level" : "crash_consistent",
      "charging_mode" : "post_paid",
      "protect_type" : "backup",
      "object_type" : "server",
      "spec_code" : "vault.backup.server.normal",
      "used" : 0,
      "status" : "available",
      "size" : 40
    },
    "tags" : [ {
      "key" : "fds"
    } ]
  }
}

Status Codes

Status Code	Description
200	OK
404	Not Found

Error Codes

See Error Codes.

Parent topic: Vaults

Previous topic: Creating a Vault

Next topic: Querying the Vault List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.