Querying the Vault List

Function

This API is used to query the vault list.

URI

GET /v3/{project_id}/vaults

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cloud_type	No	String	Cloud type, which is public
enterprise_project_id	No	String	Enterprise project ID or all_granted_eps. all_granted_eps indicates querying the IDs of all enterprise projects on which the user has permissions.
id	No	String	Vault ID
limit	No	Integer	Number of records displayed per page. The value must be a positive integer. Minimum: 1 Maximum: 1000
name	No	String	Vault name
object_type	No	String	Object type, which can be server or disk
offset	No	Integer	Offset value. The value must be a positive integer.
policy_id	No	String	Policy ID
protect_type	No	String	Protection type, which is backup
resource_ids	No	String	Resource ID
status	No	String	Status

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
vaults	Array of Vault objects	Vault instance list
count	Integer	Number of vaults
limit	Integer	Number of records displayed on each page Minimum: 1 Maximum: 1000 Default: 1000
offset	Integer	Offset where the query starts Minimum: 0 Default: 0

**Table 5** Vault
Parameter	Type	Description
billing	Billing object	Operation info
description	String	User-defined vault description Minimum: 0 Maximum: 255
id	String	Vault ID
name	String	Vault name Minimum: 1 Maximum: 64
project_id	String	Project ID
provider_id	String	ID of the vault resource type
resources	Array of ResourceResp objects	Vault resources
tags	Array of Tag objects	Vault tags
enterprise_project_id	String	Enterprise project ID. Its default value is 0.
auto_bind	Boolean	Indicates whether automatic association is enabled. Its default value is false (not enabled).
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 auto capacity expansion for the vault.

**Table 6** Billing
Parameter	Type	Description
allocated	Integer	Allocated capacity, in GB.
charging_mode	String	Billing mode, which is post_paid
cloud_type	String	Cloud type, which is public
consistent_level	String	Vault specification, which can be crash_consistent (crash consistent backup) or app_consistent (application consistency backup)
object_type	String	Object type, which can be server, disk, or turbo
order_id	String	Order ID
product_id	String	Product ID
protect_type	String	Protection type, which is backup
size	Integer	Capacity, in GB Minimum: 1 Maximum: 10485760
spec_code	String	Specification code 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 Enumeration values: available lock frozen deleting error
storage_unit	String	Name of the bucket for the vault
used	Integer	Used capacity, in MB.
frozen_scene	String	Scenario when an account is frozen

**Table 7** ResourceResp
Parameter	Type	Description
id	String	ID of the resource to be backed up
name	String	Name of the resource to be backed up Minimum: 0 Maximum: 255
protect_status	String	Protection status Enumeration values: available error protecting restoring removing
size	Integer	Allocated capacity for the associated resources, in GB
type	String	Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, or OS::Sfs::Turbo
backup_size	Integer	Backup size
backup_count	Integer	Number of backups

**Table 8** VaultBindRules
Parameter	Type	Description
tags	Array of Tag objects	Filters automatically associated resources by tag.

Example Requests

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

Example Responses

Status code: 200

{
  "vaults" : [ {
    "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c",
    "name" : "vault-8538",
    "description" : null,
    "resources" : [ ],
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "created_at" : "2020-09-04T06:57:37.343535",
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "enterprise_project_id" : "0",
    "auto_bind" : false,
    "bind_rules" : { },
    "auto_expand" : false,
    "user_id" : "aa2999fa5ae640f28926f8fd79188934",
    "billing" : {
      "allocated" : 0,
      "cloud_type" : "public",
      "consistent_level" : "crash_consistent",
      "frozen_scene" : null,
      "charging_mode" : "post_paid",
      "order_id" : null,
      "product_id" : null,
      "protect_type" : "backup",
      "object_type" : "server",
      "spec_code" : "vault.backup.server.normal",
      "used" : 0,
      "storage_unit" : null,
      "status" : "available",
      "size" : 100
    },
    "tags" : [ ]
  } ],
  "count" : 50
}