数据库工作台
数据库工作台
数据库工作台
文档指南
请输入
产品动态
操作指南
MySQL 用户指南
数据管理
SQL 窗口
工单列表
SQL 审核工单
数据清理归档工单
运维管理
企业安全管理
veDB MySQL 用户指南
数据管理
SQL 窗口
工单列表
SQL 审核工单
数据清理归档工单
运维管理
企业安全管理
PostgreSQL 用户指南
数据管理
工单列表
企业安全管理
SQL Server 用户指南
Redis 用户指南
数据管理
运维管理
企业安全管理
MongoDB 用户指南
开发者工具
最佳实践
API参考
SQL 任务
运维管理
SQL 限流
审计日志管理
慢日志与优化建议
诊断与快照
SQL 洞察与审计
工单管理
安全管控
常见问题
权限管理 FAQ
产品通用 FAQ
故障排查
- 文档首页
数据库工作台API参考SQL 任务GetTableInfo
复制全文
下载 pdfGetTableInfo
文档反馈
问问助手调用 GetTableInfo 接口查询数据库实例的表元信息。
请求类型
同步请求。
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
名称 | 类型 | 是否必填 | 示例值 | 描述 |
InstanceID | String | 是 | mysql-bf120f****** | 数据库实例 ID。 说明 您可以按需选择以下接口查询实例 ID：
|
InstanceType | String | 是 | MySQL | 数据库类型，当前支持的数据库如下所示。
|
Database | String | 是 | company | 数据库名称。 |
Table | String | 是 | employee | 表名称。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
名称 | 类型 | 示例值 | 描述 |
TableMeta | TableMeta | 表元信息。 |
请求示例
POST /?Action=GetTableInfo&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: dbw.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AKLTYmYwNjAzYjFmMjRkNDQwZWI4MzI1MzhjZGYyM******/20210328/cn-beijing/dbw/request, SignedHeaders=x-date, Signature=e1d274292f8b36eb096e1d2fec02822bd2e5cb3435699938adb7341861******
{
"InstanceID": "mysql-bf120f******",
"InstanceType": "MySQL",
"Database": "company",
"Table": "employee"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2025112718185428251AE9D8163504FCB4-a543ea",
"Action": "GetTableInfo",
"Version": "2018-01-01",
"Service": "dbw",
"Region": "cn-beijing"
},
"Result": {
"TableMeta": {
"CharacterSet": "utf8mb4",
"Collations": "utf8mb4_general_ci",
"Columns": [
{
"AllowBeNull": false,
"Comment": "",
"IsAutoIncrement": true,
"IsPrimaryKey": true,
"Length": "11",
"Name": "id",
"PrimaryKeyOrder": "1",
"Type": "bigint"
},
{
"AllowBeNull": false,
"Comment": "",
"IsAutoIncrement": false,
"IsPrimaryKey": false,
"Length": "60",
"Name": "name",
"PrimaryKeyOrder": "",
"Type": "varchar"
},
{
"AllowBeNull": false,
"Comment": "",
"IsAutoIncrement": false,
"IsPrimaryKey": false,
"Length": "10",
"Name": "age",
"PrimaryKeyOrder": "",
"Type": "smallint"
},
{
"AllowBeNull": false,
"Comment": "",
"IsAutoIncrement": false,
"IsPrimaryKey": false,
"Length": "60",
"Name": "city",
"PrimaryKeyOrder": "",
"Type": "varchar"
},
{
"AllowBeNull": false,
"Comment": "",
"IsAutoIncrement": false,
"IsPrimaryKey": false,
"Length": "60",
"Name": "department",
"PrimaryKeyOrder": "",
"Type": "varchar"
}
],
"Definition": "CREATE TABLE `employee` (\n `id` bigint(11) NOT NULL AUTO_INCREMENT,\n `name` varchar(60) NOT NULL,\n `age` smallint(10) NOT NULL,\n `city` varchar(60) NOT NULL,\n `department` varchar(60) NOT NULL,\n PRIMARY KEY (`id`)\n) ENGINE=InnoDB AUTO_INCREMENT=16394 DEFAULT CHARSET=utf8mb4",
"Engine": "InnoDB",
"Name": "employee",
}
}
}
错误码
最近更新时间：2025.11.28 16:36:58
这个页面对您有帮助吗？
有用
有用
无用
无用