DescribeDBClusterSpaceSummary - 查看集群的空间概览_云原生数据仓库AnalyticDB MySQL版(AnalyticDB for MySQL)-阿里云帮助中心

查看实例的空间概览信息，包括总数据量、热数据量、冷数据量、数据增长量等。

接口说明

当前服务的接入地址请参见 https://help.aliyun.com/zh/analyticdb-for-mysql/developer-reference/api-adb-2021-12-01-endpoint?spm=a2c4g.11186623.0.0.50182463TpsIoI。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	AnalyticDB MySQL 湖仓版 3.0 集群 ID。	amv-wz9v5sa7mm79z4l2
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息，包括地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	object	返回数据。
TotalSize	string	总数据量，单位：Byte。说明计算公式为：总数据量 = 热数据总量 + 冷数据总量。	8388608
HotData	object	热数据。
TotalSize	long	热数据总量，单位：Byte。说明计算公式为：热数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。	4194304
DataSize	long	表记录数据量，单位：Byte。	1048576
IndexSize	long	普通索引数据量，单位：Byte。	1048576
PrimaryKeyIndexSize	long	主键索引数据量，单位：Byte。	1048576
OtherSize	long	其他，单位：Byte。	1048576
ColdData	object	冷数据。
TotalSize	long	冷数据总量，单位：Byte。说明计算公式为：冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。	4194304
DataSize	long	表记录数据量，单位：Byte。	1048576
IndexSize	long	普通索引数据量，单位：Byte。	1048576
PrimaryKeyIndexSize	long	主键索引数据量，单位：Byte。	1048576
OtherSize	long	其他，单位：Byte。	1048576
DataGrowth	object	数据增长量。
DayGrowth	long	近 1 天增长量，单位：Byte。说明计算公式为：近 1 天增长量 = 当前总数据量 - 1 天前总数据量。	1048576
WeekGrowth	long	近 7 天日均增长量，单位：Byte。说明计算公式为：近 7 天日均增长量 = (当前总数据量 - 7 天前总数据量) / 7。	1048576

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。