DescribeDBClusterSpaceSummary API Reference - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the storage overview of an AnalyticDB for MySQL cluster, including 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeDBClusterSpaceSummary

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	object	The storage overview.
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 information.
TotalSize	integer	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	integer	The data size of table records. Unit: bytes.	1048576
IndexSize	integer	The data size of regular indexes. Unit: bytes.	1048576
PrimaryKeyIndexSize	integer	The data size of primary key indexes. Unit: bytes.	1048576
OtherSize	integer	The data size of other data. Unit: bytes.	1048576
ColdData	object	The cold data information.
TotalSize	integer	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	integer	The data size of table records. Unit: bytes.	1048576
IndexSize	integer	The data size of regular indexes. Unit: bytes.	1048576
PrimaryKeyIndexSize	integer	The data size of primary key indexes. Unit: bytes.	1048576
OtherSize	integer	The data size of other data. Unit: bytes.	1048576
DataGrowth	object	The data growth information.
DayGrowth	integer	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	integer	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.