All Products
Search
Document Center

Data Management:GetDataTrackJobTableMeta

最終更新日:Oct 21, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the ticket. You can call the ListOrders operation to query the ID of the ticket.

12345
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The ID of the request.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Successboolean

Indicates whether the request was successful. Valid values:

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

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
TableMetaListarray<object>

The metadata of tables.

TableMetaobject

The metadata of a table.

SchemaNamestring

The name of the database.

DB165
TableNamestring

The name of the table.

live_stat
Columnsarray<object>

The information about columns.

Columnobject

The information about a column.

ColumnNamestring

The name of the column.

claimantno
ColumnPositioninteger

The position of the column.

1
ColumnTypestring

The data type of the column. Examples: BIGINT, INT, and VARCHAR.

BIGINT
Fictiveboolean

Indicates whether the column is a virtual column. Valid values:

  • true
  • false
false
Charsetstring

The name of the character set.

utf8mb4

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history