All Products
Search
Document Center

Data Management:GetMetaTableColumn

Last Updated:Mar 28, 2024

Queries the details of columns in a table.

Operation description

You can call this operation only for database instances whose control mode is Security Collaboration.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetMetaTableColumnRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.

3***
TableGuidstringYes

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

  • If the database to which the table belongs is a logical database, you can call the ListLogicTables operation to obtain the value of this parameter.
  • If the database to which the table belongs is a physical database, you can call the ListTables operation to obtain the value of this parameter.
IDB_40753****.qntest2.activity_setting

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The error code returned.

MissingTableGuid
ColumnListobject []

The details about fields in the table.

ColumnTypestring

The data type of the column.

Note The return value of a column is not unique, such as bigint or int.
bigint(1)
AutoIncrementboolean

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
ColumnIdstring

The ID of the column.

63513****
ColumnNamestring

The name of the column.

has_promotion
SecurityLevelstring

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
PrimaryKeystring

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

  • true: The field is the primary key.
  • false: The field is not the primary key.
true
Descriptionstring

The description of the column.

Whether discounts are provided
DataPrecisioninteger

The precision of the field.

19
DataScaleinteger

The number of decimal places for the field.

0
Positioninteger

The position of the field in the table.

1
Nullableboolean

Indicates whether the field can be empty. Valid values:

  • true: The field can be empty.
  • false: The field cannot be empty.
false
DataLengthlong

The length of the field.

0
ErrorMessagestring

The error message returned.

TableGuid is mandatory for this action.
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history