Help Center/ DataArts Studio/ API Reference/ Manager API/ Metadata Acquisition/ Obtaining Table Fields in the Data Source (to Be Brought Offline)
Updated on 2025-11-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Table Fields in the Data Source (to Be Brought Offline)

Function

This API is used to obtain table fields in the data source.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/{connection_id}/datatables/{table_id}/columns

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

connection_id

Yes

String

Data connection ID, which can be obtained from the data connection list.

table_id

Yes

String

Table ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

String

Maximum number of data records

offset

No

String

Offset

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

workspace

Yes

String

Workspace ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

table_id

String

ID of a data table

total_count

Integer

Number of fields in the current table

columns

Array of ColumnsList objects

Field list
Table 5 ColumnsList

Parameter

Type

Description

comment

String

Field comment

column_name

String

Field name

column_type

String

Field type

seq_number

Integer

Field sequence

primary

Boolean

Whether the field is a primary key

partition_col

Boolean

Whether to split fields

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Returned error information.

error_code

String

Returned error code.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Returned error information.

error_code

String

Returned error code.

Example Requests

None

Example Responses

Status code: 200

The list of fields is returned.

{
  "columns" : [ {
    "comment" : "",
    "column_name" : "age",
    "column_type" : "integer",
    "seq_number" : 2,
    "primary" : false,
    "partition_col" : false
  }, {
    "comment" : "",
    "column_name" : "address",
    "column_type" : "character varying",
    "seq_number" : 3,
    "primary" : false,
    "partition_col" : false
  }, {
    "comment" : "",
    "column_name" : "phone_number",
    "column_type" : "character varying",
    "seq_number" : 4,
    "primary" : false,
    "partition_col" : false
  } ],
  "total_count" : 7,
  "table_id" : "NativeTable-9b18c0ad6ef5404caef4e6cbaccdae6f-postgres-dm_autotest-QQQQQQQstudents_infoweq"
}

Status code: 400

Bad request.

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

Status code: 500

Internal server error.

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

Status Codes

Status Code

Description

200

The list of fields is returned.

400

Bad request.

500

Internal server error.
Parent Topic: Metadata Acquisition