Data Management:GetDataTrackJobTableMeta - Data Management - Alibaba Cloud - Data Management

Queries the metadata of tables involved in a data tracking task.

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:GetDataTrackJobTableMeta

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID. You can call the ListOrders operation to query the ticket ID.	12345
Tid	integer	No	The tenant ID. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
TableMetaList	array<object>	The metadata of tables.
	array<object>	The metadata of a table.
SchemaName	string	The name of the database.	DB165
TableName	string	The name of the table.	live_stat
Columns	array<object>	The column information.
	object	The details of a column.
ColumnName	string	The name of the column.	claimantno
ColumnPosition	integer	The position of the column.	1
ColumnType	string	The data type of the column. Examples: BIGINT, INT, and VARCHAR.	BIGINT
Fictive	boolean	Whether the column is virtual. Valid values: true false	false
Charset	string	The character set name.	utf8mb4

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "TableMetaList": [
    {
      "SchemaName": "DB165",
      "TableName": "live_stat",
      "Columns": [
        {
          "ColumnName": "claimantno",
          "ColumnPosition": 1,
          "ColumnType": "BIGINT",
          "Fictive": false,
          "Charset": "utf8mb4"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.