Querying Data Disk Space Usage

Function

This API is used to query data disk space usage. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/database-volume-summary

**Table 1** Parameter description
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 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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
data_disk_capacity	String	Definition Total data disk capacity. Range N/A
data_disk_usage	String	Definition Data disk usage. Range N/A
space_usage_growth_per_day	String	Definition Daily average space usage increase. Range N/A
estimated_remaining_days	String	Definition Available days of storage. Range N/A
cn_components	Array of objects	Definition CN information. For details, see Table 4.
dn_components	Array of objects	Definition DN information. For details, see Table 5.

**Table 4** cn_components
Parameter	Type	Description
node_id	String	Definition Node ID. Range N/A
component_id	String	Definition Component ID. Range N/A
node_name	String	Definition Node name. Range N/A

**Table 5** dn_components
Parameter	Type	Description
node_id	String	Definition Node ID. Range N/A
component_id	String	Definition Component ID. Range N/A
role	String	Definition Component role. Range N/A
node_name	String	Definition Node name. Range N/A

Example Request

Querying data disk space usage

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/database-volume-summary

Example Response

{
    "data_disk_capacity": "120",
    "data_disk_usage": "11.08",
    "space_usage_growth_per_day": "2.5250",
    "estimated_remaining_days": "43.14",
    "cn_components": [
        {
            "node_id": "7f4659f811d94b3593fe4b590a94b258no14",
            "component_id": "cn_5001",
            "node_name": "gauss-e656_gaussdbv5_hcs2-0_0"
        }
    ],
    "dn_components": [
        {
            "node_id": "7f4659f811d94b3593fe4b590a94b258no14",
            "component_id": "dn_6001",
            "role": "slave",
            "node_name": "gauss-e656_gaussdbv5_hcs2-0_0"
        },
        {
            "node_id": "7f4659f811d94b3593fe4b590a94b258no14",
            "component_id": "dn_6005",
            "role": "slave",
            "node_name": "gauss-e656_gaussdbv5_hcs2-0_0"
        }
    ]
}