Querying Shard Storage Information

Function

This API is used to query shard storage information. 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}/shard-volume-usage

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	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	String	Definition Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances. 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 a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn: Chinese en-us: English Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
group_disk_infos	Array of objects	Definition Storage information of each shard in the list. For details, see Table 4.

**Table 4** Data structure description of the **group_disk_infos** field
Parameter	Type	Description
name	String	Definition Shard name. Range N/A
used	Double	Definition Shard storage usage (%). Range N/A
total	Double	Definition Shard storage space (GB). Range N/A
group_id	String	Definition Shard group ID. Range N/A

Example Request

Querying shard storage information

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

Example Response

Shard storage information queried.

{
    "group_disk_infos": [
        {
            "name": "gaussdbv5dn1",
            "used": 6.83,
            "total": 40,
            "group_id": "30c375a15cf4470e80afb0ecdfac00c0gr14"
        },
        {
            "name": "gaussdbv5dn2",
            "used": 44.52,
            "total": 80,
            "group_id": "cc7f8dc312b34b75b94ca00f0c41f6d0gr14"
        }
    ]
}