All Products
Search
Document Center

AnalyticDB:DescribeDBClusterSpaceSummary

Last Updated:Aug 30, 2024

Queries the storage overview information of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster, such as the total data size, hot data size, cold data size, and data growth.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeDBClusterSpaceSummaryget
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
am-bp1u8c0mgfg58****
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

25B56BC7-4978-40B3-9E48-4B7067******
Dataobject

The queried storage overview information.

TotalSizestring

The total data size. Unit: bytes.

Note Formula: Total data size = Hot data size+ Cold data size.
8388608
HotDataobject

The hot data.

TotalSizelong

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 + Other data size.
4194304
DataSizelong

The data size of table records. Unit: bytes.

1048576
IndexSizelong

The data size of regular indexes. Unit: bytes.

1048576
PrimaryKeyIndexSizelong

The data size of primary key indexes. Unit: bytes.

1048576
OtherSizelong

The other data size. Unit: bytes.

1048576
ColdDataobject

The cold data.

TotalSizelong

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 + Other data size.
4194304
DataSizelong

The data size of table records. Unit: bytes.

1048576
IndexSizelong

The data size of regular indexes. Unit: bytes.

1048576
PrimaryKeyIndexSizelong

The data size of primary key indexes. Unit: bytes.

1048576
OtherSizelong

The other data size. Unit: bytes.

1048576
DataGrowthobject

The data growth.

DayGrowthlong

The data growth within the last day. Unit: bytes.

Note Formula: Data growth within the last day = Current data size - Data size of one day ago.
1048576
WeekGrowthlong

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 of seven days ago)/7.
1048576

Examples

Sample success responses

JSONformat

{
  "RequestId": "25B56BC7-4978-40B3-9E48-4B7067******",
  "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 codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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.