文档首页/云数据库 GaussDB/API参考/API（推荐）/空间分析/查询实例中TOP20 表占用空间大小列表 - QueryingtheTop20TablesbyStorageUsageinanInstance
更新时间：2026-03-04 GMT+08:00
查看PDF
分享

查询实例中TOP20 表占用空间大小列表 - QueryingtheTop20TablesbyStorageUsageinanInstance

功能介绍

查询实例中TOP20 表占用空间大小列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3.1/{project_id}/instances/{instance_id}/top-table-volume

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

job_id

否

String

参数解释：

工作流ID，通过首次调用当前接口且不传递任何任务参数来获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

node_id

否

String

参数解释：

工作流执行节点ID，通过首次调用当前接口且不传递任何任务参数来获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

table_volumes

Array of objects

参数解释：

数据库表占用空间列表，当请求参数job_id不为空时返回。详情请参见表5 TableVolume。

total_count

Integer

参数解释：

总数，当请求参数job_id不为空时返回。

取值范围：

不涉及。

job_id

String

参数解释：

任务ID，当无请求参数时返回。

取值范围：

不涉及。

node_id

String

参数解释：

工作流执行节点ID，当无请求参数时返回。

取值范围：

不涉及。

state

String

参数解释：

任务状态，当请求参数job_id不为空时返回。

取值范围：

  • FINISHED：已完成。
  • RUNNING：正在运行中。
  • ERROR：失败。
表5 TableVolume

参数

参数类型

描述

table_size

String

参数解释：

表的大小。

取值范围：

不涉及。

id

String

参数解释：

表ID。

取值范围：

不涉及。

table_name

String

参数解释：

表名称。

取值范围：

不涉及。

table_owner

String

参数解释：

表所属用户名称。

取值范围：

不涉及。

schema_name

String

参数解释：

schema名称。

取值范围：

不涉及。

database_name

String

参数解释：

数据库名称。

取值范围：

不涉及。

is_part_type

Boolean

参数解释：

表或者索引是否具有分区表的性质。

取值范围：

  • true：具有分区表的性质。
  • false：不具有分区表的性质。

is_hash_cluster_key

Boolean

参数解释：

是否包含hash分区列信息。

取值范围：

取值范围：

  • true：包含hash分区列信息。
  • false：不包含hash分区列信息。

tuples

String

参数解释：

表中行的数目。

取值范围：

不涉及。

create_time

String

参数解释：

创建时间。

取值范围：

不涉及。

update_time

String

参数解释：

修改时间。

取值范围：

不涉及。

average_size

String

参数解释：

表大小平均值(totalsize/DN个数，该值为平均分布的理想情况下，表在各DN占用空间大小)。

取值范围：

不涉及。

max_ratio

String

参数解释：

单DN表大小最大值占比（表在各DN占用空间的最大值/totalsize）。

取值范围：

不涉及。

min_ratio

String

参数解释：

单DN表大小最小值占比（表在各DN占用空间的最小值/totalsize）。

取值范围：

不涉及。

skew_size

String

参数解释：

表分布倾斜值（单DN表大小最大值 - 单DN表大小最小值）。

取值范围：

不涉及。

skew_ratio

String

参数解释：

表分布倾斜率（skewsize/totalsize）。

取值范围：

不涉及。

skew_stddev

String

参数解释：

表分布标准方差（在表大小一定的情况下，该值越大表明表的整体分布情况越倾斜）。

取值范围：

不涉及。

请求示例

  • 查询实例中TOP20 表占用空间大小列表。 
    GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/top-table-volume?job_id=SPACE_ANALYTICS_-121b4edd-940b-4b4f-a246-334f1a6658d6-47ec&node_id=a8dfad34a4b246f49a12012914b727ddno14?job_id=SPACE_ANALYTICS_-121b4edd-940b-4b4f-a246-334f1a6658d6-47ec&node_id=a8dfad34a4b246f49a12012914b727ddno14
  • 获取TOP 20 表占用空间大小列表任务ID。 
    GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/top-table-volume

响应示例

  • 查询实例中TOP20 表占用空间大小列表。 
    {
    "table_volumes": [
        {
            "id": "17131",
            "table_name": "Table_AAA",
            "table_owner": "Adaptor",
            "database_name": "DB_ttsA",
            "schema_name": "Schema_AA",
            "is_part_type": false,
            "is_hash_cluster_key": false,
            "tuples": "0",
            "create_time": "2025-04-17 11:00:24.667761+08",
            "update_time": "2025-04-17 11:00:24.667761+08",
            "average_size": "3176 kB",
            "max_ratio": "0.336",
            "min_ratio": "0.330",
            "skew_size": "57344",
            "skew_ratio": "0.006",
            "table_size": "24 kB",
            "skew_stddev": "29537"
        },
        {
            "id": "17137",
            "table_name": "Table_BAA",
            "table_owner": "Adaptor",
            "database_name": "DB_ttsB",
            "schema_name": "Schema_BA",
            "is_part_type": false,
            "is_hash_cluster_key": false,
            "tuples": "0",
            "create_time": "2025-04-17 11:00:44.878895+08",
            "update_time": "2025-04-17 11:00:44.878895+08",
            "average_size": "3171 kB",
            "max_ratio": "0.336",
            "min_ratio": "0.330",
            "table_size": "24 kB",
            "skew_size": "65536",
            "skew_ratio": "0.007",
            "skew_stddev": "33108"
        }
    ],
    "total_count": 2,
    "state": "FINISHED"
}
  • 获取TOP 20 表占用空间大小列表任务ID。 
    {
    "job_id": "SPACE_ANALYTICS_-121b4edd-940b-4b4f-a246-334f1a6658d6-47ec",
    "node_id": "a8dfad34a4b246f49a12012914b727ddno14"
}

状态码

错误码

请参见错误码。

父主题：空间分析

相关文档