获取MySQL表字段信息
更新时间：2025-05-07
接口描述
获取MySQL数据库中指定表的字段信息，包括字段名称、类型、字符集、是否可空、字段注释等详细属性。
权限说明
鉴权认证机制的详细内容请参见鉴权认证。
请求结构
Plain
1GET /api/v{version}/diagnosis/mysql/schema/table/column?product=string&appId=string&database=string&table=string HTTP/1.1
2Host: dbsc.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
OpenAPI接口参数
| 参数名称 | 类型 | 必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | Path参数 | API版本号 |
| product | string | 是 | Query参数 | 产品类型，例如：rds、gaiadbs等 |
| appId | string | 是 | Query参数 | 实例ID，例如：rdsmte2lk8ap0sl |
| database | string | 是 | Query参数 | 数据库名称，例如：mysql、information_schema等 |
| table | string | 是 | Query参数 | 表名称，例如：user_info |
响应头域
无。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| columns | List |
表字段信息列表 |
TableColumnItem 结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| schemaName | string | 数据库名称 |
| tableName | string | 表名称 |
| columnName | string | 字段名称 |
| position | int64 | 字段序号 |
| type | string | 字段类型 |
| charset | string | 字符集 |
| collation | string | 字符集校对规则 |
| length | int64 | 字段长度 |
| nullable | string | 是否可空 |
| comment | string | 字段注释 |
| defaultValue | string | 默认值 |
请求示例
Plain
1GET /api/v1/diagnosis/mysql/schema/table/column?product=rds&appId=rdsmte2lk8ap0sl&database=test_db&table=user_info HTTP/1.1
2Host: dbsc.bj.baidu.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2023-07-11T11:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
JSON
1{
2 "columns": [
3 {
4 "schemaName": "sysbench",
5 "tableName": "sbtest4",
6 "columnName": "id",
7 "position": 1,
8 "type": "int",
9 "charset": "",
10 "collation": "",
11 "length": 0,
12 "nullable": "NO",
13 "comment": "",
14 "defaultValue": ""
15 }
16 ]
17}