文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 空间分析/ 查询表定义信息
更新时间：2025-10-20 GMT+08:00
查看PDF
分享

查询表定义信息

功能介绍

查询表定义信息。

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/table-definition

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

database_name

是

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

schema_name

是

String

参数解释：

schema名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

table_name

是

String

参数解释：

表名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表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_definition

String

参数解释：

数据库表定义信息。

取值范围：

不涉及。

请求示例

查询表定义信息。

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/table-definition?database_name=test_db&table_name=sbtest178&schema_name=public

响应示例

{
    "table_definition": "SET search_path = public;\nCREATE TABLE sbtest178 (\n    id integer NOT NULL,\n    k integer DEFAULT 0 NOT NULL,\n    c character(120) DEFAULT ''::bpchar NOT NULL,\n    pad character(60) DEFAULT ''::bpchar NOT NULL\n)\nWITH (orientation=row, compression=no, storage_type=USTORE, segment=off)\nDISTRIBUTE BY HASH(id)\nTO GROUP group_version_20250429_155518_878976;\nCREATE INDEX k_178 ON sbtest178 USING ubtree (k) WITH (storage_type=USTORE) TABLESPACE pg_default;\nALTER TABLE sbtest178 ADD CONSTRAINT sbtest178_pkey PRIMARY KEY USING ubtree  (id) WITH (storage_type=USTORE);"
}

状态码

错误码

请参见错误码。

父主题： 空间分析