doc-exports/docs/rds/api-ref/rds_04_0003.html

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.
• Before calling this API, obtain the required region and endpoint.

Constraints

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

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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/storage-used-space

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.

Request

• Request parameters

  Table 2 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

• Example

  GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/314958daf6904c478d17c642ac209abbin01/storage-used-space

Response

• Normal response

  Table 3 Parameter description

  Name	Type	Description
  node_id	String	Instance node ID.
  used	String	Used storage, in GB.

• Example normal response

  {
    "node_id" : "0314958daf6904c478d17c642ac209abbin01",
    "used" : "14.21"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: API v3 (Recommended)