GetMetaTableDetailInfo: Retrieve Column & Index Metadata for Schema Audits - Data Management

Retrieves metadata for a table, including its columns and indexes.

Operation description

This API can only be called for Database Instances where the Control Mode is set to Secure 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:GetMetaTableDetailInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Note To obtain this ID, hover over your profile picture in the upper-right corner of the console. For more information, see View tenant information.	123
TableGuid	string	Yes	The globally unique identifier (GUID) of the table in Data Management (DMS). Note Logical database: Call the ListLogicTables operation and set the ReturnGuid parameter to true. Physical database: Call the ListTables operation and set the ReturnGuid parameter to true.	IDB_L_9032.db-test.yuyang_test
RealLoginUserUid	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E881CB2F-DE42-42E5-90EB-8B3173DCB9B9
DetailInfo	object	The table details.
IndexList	array<object>	The index list.
	object
IndexColumns	array	A list of indexed columns.
	string	An indexed column.	id
IndexName	string	The index name.	PRIMARY
Unique	boolean	Indicates whether the index is unique. `true`: The index is unique. `false`: The index is not unique.	false
IndexType	string	The index type. For example, `Primary`, `Unique`, or `Normal`.	Primary
IndexId	string	The index ID.	123
ColumnList	array<object>	The column list.
	object
ColumnName	string	The column name.	id
Description	string	The column description.	test
DataScale	integer	The scale of the column.	0
DataPrecision	integer	The precision of the column.	0
ColumnType	string	The data type of the column. For example, `Bigint`, `Int`, or `Varchar`.	bigint(20) unsigned
AutoIncrement	boolean	Indicates whether auto-increment is enabled for the column. `true`: Auto-increment is enabled. `false`: Auto-increment is not enabled.	true
Position	string	The position of the column.	1
Nullable	boolean	Indicates whether the column is nullable. `true`: The column allows null values. `false`: The column does not allow null values.	false
ColumnId	string	The column ID.	191234849
DataLength	integer	The length of the column.	0
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "E881CB2F-DE42-42E5-90EB-8B3173DCB9B9",
  "DetailInfo": {
    "IndexList": [
      {
        "IndexColumns": [
          "id"
        ],
        "IndexName": "PRIMARY",
        "Unique": false,
        "IndexType": "Primary",
        "IndexId": "123"
      }
    ],
    "ColumnList": [
      {
        "ColumnName": "id",
        "Description": "test",
        "DataScale": 0,
        "DataPrecision": 0,
        "ColumnType": "bigint(20) unsigned",
        "AutoIncrement": true,
        "Position": "1",
        "Nullable": false,
        "ColumnId": "191234849",
        "DataLength": 0
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.