All Products
Search

This Product

    Data Management:GetMetaTableColumn

    Document Center

    Data Management:GetMetaTableColumn

    Last Updated:Aug 27, 2026

    Retrieves column metadata for a specified table, including data types, primary keys, and sensitivity levels.

    Operation description

    This operation is available only for database instances whose control mode is Security Collaboration.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dms:GetMetaTableColumn

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    The tenant ID. You can call the GetUserActiveTenant operation to query the tenant ID.

    3***
    TableGuid

    string

    Yes

    The globally unique identifier (GUID) of the table in Data Management (DMS).

    • For tables in a logical database, call the ListLogicTables operation to query this value.

    • For tables in a physical database, call the ListTables operation to query this value.

    IDB_40753****.qntest2.activity_setting

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    087DFBA1-378B-5D25-B13B-31F6409F****
    ErrorCode

    string

    The error code.

    MissingTableGuid
    ColumnList

    array<object>

    The column details.

    object

    ColumnType

    string

    The data type of the column.

    Note

    Values vary by column, for example, bigint or int.

    bigint(1)
    AutoIncrement

    boolean

    Indicates whether the column is an auto-increment column. Valid values:

    • true: The column is an auto-increment column.

    • false: The column is not an auto-increment column.

    false
    ColumnId

    string

    The column ID.

    63513****
    ColumnName

    string

    The column name.

    has_promotion
    SecurityLevel

    string

    The sensitivity level of the column. Valid values:

    • INNER: The column is not sensitive.

    • SENSITIVE: The column is sensitive.

    • CONFIDENTIAL: The column is confidential.

    Note

    For more information, see Sensitivity levels of columns.

    INNER
    PrimaryKey

    string

    Indicates whether the column is the primary key. Valid values:

    • true: The column is the primary key.

    • false: The column is not the primary key.

    true
    Description

    string

    The column description.

    是否有优惠活动
    DataPrecision

    integer

    The precision of the column.

    19
    DataScale

    integer

    The number of decimal places for the column.

    0
    Position

    integer

    The ordinal position of the column in the table.

    1
    Nullable

    boolean

    Indicates whether the column is nullable. Valid values:

    • true: The column is nullable.

    • false: The column is not nullable.

    false
    DataLength

    integer

    The length of the column.

    0
    ErrorMessage

    string

    The error message.

    TableGuid is mandatory for this action.
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "087DFBA1-378B-5D25-B13B-31F6409F****",
  "ErrorCode": "MissingTableGuid",
  "ColumnList": [
    {
      "ColumnType": "bigint(1)",
      "AutoIncrement": false,
      "ColumnId": "63513****",
      "ColumnName": "has_promotion",
      "SecurityLevel": "INNER",
      "PrimaryKey": "true",
      "Description": "是否有优惠活动",
      "DataPrecision": 19,
      "DataScale": 0,
      "Position": 1,
      "Nullable": false,
      "DataLength": 0
    }
  ],
  "ErrorMessage": "TableGuid is mandatory for this action.",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.