跳到主要内容

获取 Column 列表

根据表名称查询列列表。

请求地址:/openapi/v1/metadata/column/list

请求方法:GET

请求参数

参数类型是否必选说明示例
datasourceIdString数据源 ID。您可以调用获取数据源列表接口获取 datasourceIdds-d92qvqp8o1fw
databaseNameStringDatabase 名称。您可以调用获取 Database 列表接口获取 databaseName9zcloud
schemaNameStringSchema 名称。您可以调用获取 Schema 列表接口获取 schemaNamepublic
tableNameStringTable 名称。您可以调用获取 Table 列表接口获取 talbeNamepgbench_accounts

返回参数

参数类型说明示例
successBool接口调用是否成功。返回值:turefalseture
requestIdString请求 ID。Ax8w2SHX-DJGGjUVnEJLj1YCdGFq2ZEZ
dataArrayColumn 列表,包含列名称(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
}]
}