Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Storage Management/ Querying the Storage Usage of a DB Instance
Updated on 2025-08-18 GMT+08:00
View PDF

Querying the Storage Usage of a DB Instance

Function

This API is used to query the total storage and used storage of a specified DB instance. Before calling this API:

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume-usage
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

DB instance ID.

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

used

String

Used storage space of the current instance, in GB.

total

String

Total storage space of the current instance, in GB.

Example Request

Querying the storage usage of a DB instance

GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/volume-usage

Example Response

Instance storage usage queried.

{
  "used" : "15.0", 
  "total" : "185.0"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Storage Management