Querying the Vault List
Function
This API is used to query the vault list.
URI
GET /v3/{project_id}/vaults
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cloud_type |
No |
String |
Cloud type Enumeration values:
|
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 |
Resource type |
offset |
No |
Integer |
Offset value. The value must be a positive integer. |
policy_id |
No |
String |
Policy ID |
protect_type |
No |
String |
Protection type Enumeration values:
|
resource_ids |
No |
String |
Resource ID |
status |
No |
String |
Status |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. Obtained by calling the corresponding IAM API. If the request is successfully processed, the value of X-Subject-Token included in the response header is the token value. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
vaults |
Array of Vault objects |
Vault instance list |
count |
Integer |
Number of vaults |
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 |
Vault type |
resources |
Array of ResourceResp objects |
Vault resources |
tags |
Array of Tag objects |
Vault tags |
enterprise_project_id |
String |
Enterprise project ID. The default value is 0. |
auto_bind |
Boolean |
Specifies whether automatic association is enabled. The default value is false, indicating that automatic association is disabled. |
bind_rules |
VaultBindRules object |
Association rule |
user_id |
String |
User ID |
created_at |
String |
Creation time, such as 2020-02-05T10:38:34.209782 |
auto_expand |
Boolean |
Whether to automatically expand the vault capacity. Only pay-per-use vaults support this function. |
Parameter |
Type |
Description |
---|---|---|
allocated |
Integer |
Allocated capacity, in MB. |
charging_mode |
String |
Creation mode Enumeration values:
|
cloud_type |
String |
Cloud platform Enumeration values:
|
consistent_level |
String |
|
object_type |
String |
Object type Enumeration values:
|
order_id |
String |
Order ID |
product_id |
String |
Product ID |
protect_type |
String |
Protection type Enumeration values:
|
size |
Integer |
Capacity, in GB Minimum: 1 Maximum: 10485760 |
spec_code |
String |
Specification code Enumeration values:
|
status |
String |
Vault status Enumeration values:
|
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 |
Parameter |
Type |
Description |
---|---|---|
extra_info |
ResourceExtraInfo object |
Extra information of the resource |
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:
|
size |
Integer |
Allocated capacity for the associated resource, in GB |
type |
String |
|
backup_size |
Integer |
Backup size |
backup_count |
Integer |
Number of backups |
Parameter |
Type |
Description |
---|---|---|
exclude_volumes |
Array of strings |
ID of the disk that is excluded from the backup. This parameter is used only when there are VM disk backups. |
include_volumes |
Array of ResourceExtraInfoIncludeVolumes objects |
Disk to be backed up |
Parameter |
Type |
Description |
---|---|---|
id |
String |
EVS disk ID. Only UUID is supported. |
os_version |
String |
OS type |
Parameter |
Type |
Description |
---|---|---|
tags |
Array of Tag objects |
Filters automatically associated resources by tag. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "vaults" : [ { "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c", "name" : "vault-8538", "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", "charging_mode" : "post_paid", "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "status" : "available", "size" : 100 }, "tags" : [ ] } ], "count" : 50 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot