Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Vaults/ Querying Vault Usage of a Project
Updated on 2024-05-11 GMT+08:00

Querying Vault Usage of a Project

Function

This API is used to query the total capacity and used capacity of all vaults of a project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v3/{project_id}/vaults/summary

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

size

Integer

Total capacity

Minimum: 0

used_size

Integer

Total used capacity

Minimum: 0

Example Requests

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

Example Responses

Status code: 200

OK

{
  "size" : 27670,
  "used_size" : 43
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.