GetTableColumnList

Retrieves the details for each column in a table, including metadata, business descriptions, and security level.

Operation description

Retrieves detailed information for each column in a table. This operation returns the metadata (such as type, nullable, and auto-increment), business description, associated terms, data standards, security level, and index information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DbId	integer	Yes	The ID of the database. Call the ListDatabases operation to obtain this ID.	1***
TableName	string	Yes	The name of the table.	order_info

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request succeeded. false: The request failed.	true
Data	array	An array of column details.
	ColumnKnowledgeVO	The details of a column.	true

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": [
    {
      "TableId": 0,
      "ColumnId": 0,
      "ColumnName": "",
      "Position": 0,
      "ColumnType": "",
      "Description": "",
      "AssetDescription": "",
      "Title": "",
      "AssetModifiedGmt": "",
      "LevelType": "",
      "Level": 0,
      "HotLevel": 0,
      "Nullable": false,
      "AutoIncrement": false,
      "ColumnKeyType": "",
      "UserSensitivityLevel": "",
      "Plain": false,
      "SecurityLevel": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.