All Products
Search
Document Center

Data Management:CreateDataTrackOrder

Last Updated:Aug 27, 2026

Creates a data tracking ticket to track data changes in a database.

Operation description

This operation applies only to instances managed in Security Collaboration mode.

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

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Comment

string

Yes

The purpose or objective of the data tracking ticket. Helps reduce unnecessary communication.

业务测试.

RelatedUserList

array

No

The IDs of the operators that are related to the ticket.

string

No

The ID of an operator that is related to the ticket.

123***

Param

object

Yes

The parameters of the ticket.

DbId

string

Yes

The ID of the database. You can call the SearchDatabases operation to query the database ID.

Note

This operation supports only physical databases. Logical databases are not supported.

123***

JobStartTime

string

Yes

The start time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.

2023-04-23 00:00:00

JobEndTime

string

Yes

The end time of the time range in which you want to track data operations. The time must be in the yyyy-MM-dd HH:mm:ss format.

2023-04-23 10:00:00

TableNames

array

Yes

The names of the tables for which you want to track data operations.

string

No

The name of a table for which you want to track data operations.

table2

TrackTypes

array

Yes

The types of data operations that you want to track.

string

No

A type of data operation that you want to track. Valid values:

  • INSERT

  • UPDATE

  • DELETE

INSERT

Tid

integer

No

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

3***

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

283C461F-11D8-48AA-B695-DF092DA32AF3

Success

boolean

Indicates 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

CreateOrderResult

array

The IDs of the data tracking tickets.

integer

The ID of the data tracking ticket.

12***

Examples

Success response

JSON format

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.