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

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 /v3/{project_id}/instances/{instance_id}/volume-usage
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

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

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

used

String

Definition

Used storage space of the current instance, in GB.

Range

N/A

total

String

Definition

Total storage space of the current instance, in GB.

Range

N/A

Example Request

Querying the storage usage of a DB instance

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/volume-usage

Example Response

Instance storage usage queried.

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

Status Codes

Error Codes

For details, see Error Codes.