DescribeDBClusterSpaceSummary - AnalyticDB

Queries the storage overview information of an AnalyticDB for MySQL cluster, such as the total data size, hot data size, cold data size, and data growth.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeDBClusterSpaceSummary	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.	amv-wz9v5sa7mm79z4l2
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	object	The queried storage overview information.
TotalSize	string	The total data size. Unit: bytes. Note Formula: Total data size = Hot data size+ Cold data size.	8388608
HotData	object	The hot data.
TotalSize	long	The hot data size. Unit: bytes. Note Formula: Hot data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.	4194304
DataSize	long	The data size of table records. Unit: bytes.	1048576
IndexSize	long	The data size of regular indexes. Unit: bytes.	1048576
PrimaryKeyIndexSize	long	The data size of primary key indexes. Unit: bytes.	1048576
OtherSize	long	The data size of other data. Unit: bytes.	1048576
ColdData	object	The cold data.
TotalSize	long	The cold data size. Unit: bytes. Note Formula: Cold data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.	4194304
DataSize	long	The data size of table records. Unit: bytes.	1048576
IndexSize	long	The data size of regular indexes. Unit: bytes.	1048576
PrimaryKeyIndexSize	long	The data size of primary key indexes. Unit: bytes.	1048576
OtherSize	long	The data size of other data. Unit: bytes.	1048576
DataGrowth	object	The data growth.
DayGrowth	long	The data growth within the last day. Unit: bytes. Note Formula: Data growth within the last day = Current data size - Data size one day ago.	1048576
WeekGrowth	long	The daily data growth within the last seven days. Unit: bytes. Note Formula: Daily data growth within the last seven days = (Current data size - Data size seven days ago)/7.	1048576

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Data": {
    "TotalSize": "8388608",
    "HotData": {
      "TotalSize": 4194304,
      "DataSize": 1048576,
      "IndexSize": 1048576,
      "PrimaryKeyIndexSize": 1048576,
      "OtherSize": 1048576
    },
    "ColdData": {
      "TotalSize": 4194304,
      "DataSize": 1048576,
      "IndexSize": 1048576,
      "PrimaryKeyIndexSize": 1048576,
      "OtherSize": 1048576
    },
    "DataGrowth": {
      "DayGrowth": 1048576,
      "WeekGrowth": 1048576
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

For a list of error codes, visit the Service error codes.