获取 Column 列表
根据表名称查询列列表。
请求地址:/openapi/v1/metadata/column/list
请求方法:GET
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| datasourceId | String | 是 | 数据源 ID。您可以调用获取数据源列表接口获取 datasourceId。 | ds-d92qvqp8o1fw |
| databaseName | String | 是 | Database 名称。您可以调用获取 Database 列表接口获取 databaseName。 | 9zcloud |
| schemaName | String | 否 | Schema 名称。您可以调用获取 Schema 列表接口获取 schemaName。 | public |
| tableName | String | 是 | Table 名称。您可以调用获取 Table 列表接口获取 talbeName。 | pgbench_accounts |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Bool | 接口调用是否成功。返回值:ture、false。 | ture |
| requestId | String | 请求 ID。 | Ax8w2SHX-DJGGjUVnEJLj1YCdGFq2ZEZ |
| data | Array | Column 列表,包含列名称(columnName)、列注释(columnComment)、数据类型(dataType)、长度(length)、数据精度(scale)、是否无符号(unsigned)、是否可空(nullable)、字符集(charsetName)、校对集(collationName)、列位置序号(ordinalPosition)、列默认值(columnDefault)等信息。 | { "columnName": "id", "dataType": "bigint", "length": 64, "scale": 0, "unsigned": false, "nullable": true, "ordinalPosition": 0 } |
调用成功示例
{
"success": true,
"requestId": "Ax8w2SHX-DJGGjUVnEJLj1YCdGFq2ZEZ",
"data": [{
"columnName": "id",
"dataType": "bigint",
"length": 64,
"scale": 0,
"unsigned": false,
"nullable": true,
"ordinalPosition": 0
}]
}