文档

DescribeDBClusterSpaceSummary - 查看集群的空间概览

更新时间:

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

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDBClusterSpaceSummaryget
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

企业版、基础版或湖仓版的集群 ID。

amv-wz9v5sa7mm79z4l2
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看支持的地域和可用区信息,包括地域 ID。
cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Dataobject

返回数据。

TotalSizestring

总数据量,单位:Byte。

说明 计算公式为:总数据量 = 热数据总量 + 冷数据总量。
8388608
HotDataobject

热数据。

TotalSizelong

热数据总量,单位:Byte。

说明 计算公式为:热数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。
4194304
DataSizelong

表记录数据量,单位:Byte。

1048576
IndexSizelong

普通索引数据量,单位:Byte。

1048576
PrimaryKeyIndexSizelong

主键索引数据量,单位:Byte。

1048576
OtherSizelong

其他,单位:Byte。

1048576
ColdDataobject

冷数据。

TotalSizelong

冷数据总量,单位:Byte。

说明 计算公式为:冷数据总量 = 表记录数据量 + 普通索引数据量 + 主键索引数据量 + 其他。
4194304
DataSizelong

表记录数据量,单位:Byte。

1048576
IndexSizelong

普通索引数据量,单位:Byte。

1048576
PrimaryKeyIndexSizelong

主键索引数据量,单位:Byte。

1048576
OtherSizelong

其他,单位:Byte。

1048576
DataGrowthobject

数据增长量。

DayGrowthlong

近 1 天增长量,单位:Byte。

说明 计算公式为:近 1 天增长量 = 当前总数据量 - 1 天前总数据量。
1048576
WeekGrowthlong

近 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错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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