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

Querying Storage Usage of a DB Instance

Function

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

  • Before calling an API, you need to understand the API in Authentication.

Constraints

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

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    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.

    Constraints:

    N/A

    Value range:

    N/A

    Default value:

    N/A

    instance_id

    Yes

    Explanation:

    ID of the instance to be queried.

    Constraints:

    N/A

    Value 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

    Explanation:

    Instance node ID.

    Value range:

    N/A

    used

    String

    Explanation:

    Used storage, in GB.

    Value 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.