DescribeDBClusterSpaceSummary - 查看集群的空间概览 - 云原生数据仓库AnalyticDB

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeDBClusterSpaceSummary	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	数仓版集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的集群 ID。	am-bp1u8c0mgfg58****
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看数仓版支持的地域和可用区信息，包括地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	25B56BC7-4978-40B3-9E48-4B7067******
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": "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
    }
  }
}

错误码

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

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