更新时间:2025-09-11 GMT+08:00
分享

导出表信息

功能介绍

表信息导出。

调试

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

URI

POST /v3/{project_id}/instances/{instance_id}/table-volume/export

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

参数解释:

实例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:降序。
  • ASC:升序。

默认取值

不涉及。

响应参数

无。

请求示例

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/1528a5fecb4449ec9d383630ec58b1d3/instances/d04686c6baae4f65a742771186f47b7ain14/table-volume/export
{
  "database_name": "postgres",
  "schema_names": [
    "snapshot"
  ]
}

响应示例

无。

状态码

错误码

请参见错误码

相关文档