Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Querying Storage Usage of a DB Instance
Updated on 2025-08-20 GMT+08:00

Querying Storage Usage of a DB Instance

Function

This API is used to query storage usage of a DB instance.

Constraints

This API is available only for the MySQL and SQL Server DB engines.

To query the storage usage of an RDS for PostgreSQL instance, you can call the API for querying DB instances and check the value of the response parameter storage_used_space.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/storage-used-space

  • Parameter description
    Table 1 Parameters

    Parameter

    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

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    ID of the instance to be queried.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

    GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/314958daf6904c478d17c642ac209abbin01/storage-used-space

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    node_id

    String

    Definition

    Instance node ID.

    Range

    N/A

    used

    String

    Definition

    Used storage, in GB.

    Range

    N/A

  • Example normal response
    {
      "node_id" : "0314958daf6904c478d17c642ac209abbin01",
      "used" : "14.21"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.