Help Center/Host Security Service/API Reference/API Description/Ransomware Prevention/Querying the Backup Vault List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Backup Vault List

Function

This API is used to query the backup vault list. If a server needs to be bound, the following conditions must be met: 1. The vault is in the Available state. 2. The backup policy is in the Enabled state. 3. The vault has available backup capacity. 4. The number of servers bound to the vault is less than 256.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/ransomware/optional/vaults

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

vault_name

No

String

Backup vault name

vault_id

No

String

Backup vault ID

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Query the total number of backup vaults.

data_list

Array of BackupVaultInfo objects

This API is used to query the backup vault list.

Table 5 BackupVaultInfo

Parameter

Type

Description

vault_id

String

Vault ID

vault_name

String

Vault name

vault_size

Integer

Total capacity of the vault, in GB.

vault_used

Integer

Used capacity, in MB. It indicates the capacity occupied by backups. For example, if one server is bound and two backups are created, occupying 60 GB, the used capacity is 60 GB.

vault_allocated

Integer

Allocated capacity, in GB. It indicates the capacity of the bound server. For example, if one server is bound and the server size is 40 GB, the allocated capacity is 40 GB.

vault_charging_mode

String

Vault creation mode.

  • post_paid: pay-per-use

  • pre_paid: yearly/monthly

vault_status

String

Vault status.

  • available

  • lock

  • frozen

  • deleting

  • error

backup_policy_id

String

Specifies the backup policy ID. If this parameter is empty, the backup policy is not bound. If this parameter is not empty, check whether the backup policy is enabled based on the backup_policy_enabled field.

backup_policy_name

String

Backup policy name

backup_policy_enabled

Boolean

Whether the backup policy is enabled.

resources_num

Integer

Bound servers

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 2097152,
  "data_list" : [ {
    "vault_id" : "48a-5f59-4541XXX",
    "vault_name" : "vault-XXX",
    "vault_size" : 2097152,
    "vault_used" : 2097152,
    "vault_allocated" : 2097152,
    "vault_charging_mode" : "pre_paid",
    "vault_status" : "available",
    "backup_policy_id" : "77d-6963-4ea3XXX",
    "backup_policy_name" : "policy_XXX",
    "backup_policy_enabled" : true,
    "resources_num" : 1
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Ransomware Prevention