文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 空间分析/ 查询指定schema中表占用空间大小列表 - QueryingtheStorageUsageofTablesinaSpecifiedSchema
更新时间:2025-12-25 GMT+08:00
分享

查询指定schema中表占用空间大小列表 - QueryingtheStorageUsageofTablesinaSpecifiedSchema

功能介绍

查询指定schema中表占用空间大小列表。

调试

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

URI

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

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

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

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

database_name

String

参数解释

数据库名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

schema_names

Array of strings

参数解释

schema名称列表。

约束限制

不涉及。

table_name

String

参数解释

表名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

user_name

String

参数解释

表所属用户名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

sort_key

String

参数解释

排序字段。

约束限制

不涉及。

取值范围

  • table_size:表的大小。
  • id:表ID。
  • table_name:表名称。
  • table_owner:表所属用户名称。
  • database_name:数据库名称。
  • schema_name:schema名称。
  • is_part_type:表或者索引是否具有分区表的性质。
  • is_hash_cluster_key:是否包含hash分区列信息。
  • tuples:表中行的数目。
  • create_time:创建时间。
  • update_time:修改时间。
  • average_size:表大小平均值(totalsize/DN个数,该值为平均分布的理想情况下,表在各DN占用空间大小)。
  • max_ratio:单DN表大小最大值占比(表在各DN占用空间的最大值/totalsize)。
  • min_ratio:单DN表大小最小值占比(表在各DN占用空间的最小值/totalsize)。
  • skew_size:表分布倾斜值(单DN表大小最大值 - 单DN表大小最小值)。
  • skew_ratio:表分布倾斜率(skewsize/totalsize)。
  • skew_stddev:表分布标准方差(在表大小一定的情况下,该值越大表明表的整体分布情况越倾斜)。

默认取值

不涉及。

sort_order

String

参数解释

排序方法。

约束限制

不涉及。

取值范围

  • DESC:降序。
  • desc:降序。
  • ASC:升序。
  • asc:升序。

默认取值

不涉及。

limit

Integer

参数解释

查询记录数。

约束限制

必须为数字,不能为负数。

取值范围

1 - 100

默认取值

10。

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

必须为数字,不能为负数。

取值范围

0 - 10000

默认取值

0。

响应参数

表4 响应Body参数

参数

参数类型

描述

table_volumes

Array of objects

参数解释

数据库表占用空间列表。详情请参见表5 TableVolume

total_count

Integer

参数解释

总数。

取值范围

不涉及。

表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

参数解释

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

取值范围

不涉及。

请求示例

查询指定schema中表占用空间大小列表。

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/table-volume
{
  "database_name": "db_tpcc",
  "schema_names": ["Schema_AA"],
  "table_name": "Table_AAA",
  "username": "admin",  
  "sort_key": "table_name",
  "sort_order": "asc",
  "limit": 10,
  "offset": 0
}

响应示例

{
    "table_volumes": [
        {
            "id": "17131",
            "table_name": "Table_AAA",
            "table_owner": "Adaptor",
            "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": ".336",
            "min_ratio": ".330",
            "skew_size": "57344",
            "skew_ratio": ".006",
            "table_size": "24 kB",
            "database_name": "db_tpcc",
            "skew_stddev": "29537"
        }
    ],
    "total_count": 1
}

状态码

错误码

请参见错误码

相关文档