数据表管理接口说明
更新时间：2025-08-21
创建数据表
接口描述
本接口用于在云数据库 GaiaDB-X 实例的某个数据库中创建一个数据表
请求结构
Plain Text
1POST /v{version}/instance/{instanceId}/database/{dbName}/table?clientToken={clientToken} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string
4{
5 "tableDefineList": tableDefineList
6}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| tableDefineList | List<TableDefine> | 是 | RequestBody参数 | 创建数据表请求列表 |
TableDefine
| 参数名称 | 类型 | 描述 |
|---|---|---|
| rawsql | String | 创建数据库sql语句，只能有一个sql语句，并且以英文分号结束 |
| isDistributed | String | 单表："0"，分布式表："1" |
| partitionKey | String | 分表字段，只支持varchar和int类型的字段 |
| tabletCount | int | 分表个数，取值64/128/256/512/1024/2048 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无特殊响应参数
请求示例
Plain Text
1GET https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database/dbtest/table
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "tableDefineList": [
6 {
7 "rawsql": "create table test(id int);",
8 "isDistributed": "1",
9 "partitionKey": "id",
10 "tabletCount": 128
11 }
12 ]
13}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json删除数据表
接口描述
本接口用于在云数据库 GaiaDB-X 实例的某个数据库中删除一个数据表
- 数据表状态必须为Available
请求结构
Plain Text
1DELETE /v{version}/instance/{instanceId}/database/{dbName}/table/{tableName} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| dbName | String | 是 | URI参数 | 数据库名称 |
| tableName | String | 是 | URI参数 | 数据表名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无特殊响应参数
请求示例
Plain Text
1DELETE https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database/dbtest/table/test_t
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json查询数据表列表
接口描述
本接口用于查询云数据库 GaiaDB-X 实例的某个数据库的数据表列表
请求结构
Plain Text
1GET /v{version}/instance/{instanceId}/database/{dbName}/table HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URI参数 | API版本号 |
| instanceId | String | 是 | URI参数 | 实例ID |
| dbName | String | 是 | URI参数 | 数据库名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tables | List<Table> | 数据表列表 |
Table
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tableName | String | 数据表名称 |
| status | String | 数据表状态 |
| partitionMethod | String | 分表规则，hash |
| partitionKey | String | 分表字段 |
| partitionKeyType | String | 分表字段类型 |
| isDistributed | String | 单表：0， 分布式表：1 |
请求示例
Plain Text
1GET https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3/database/dbtest/table
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5 "tables": [
6 {
7 "tableName": "test_t",
8 "status": "Available",
9 "isDistributed": "1",
10 "partitionKey": "id",
11 "partitionMethod": "hash",
12 "partitionKeyType": "INT"
13 }
14 ]
15}