All Products
Search
Document Center

Data Management:CreateDataTrackOrder

最終更新日:Oct 21, 2024

Creates a data tracking ticket.

Operation description

This operation is available only for instances that are managed in Security Collaboration mode.

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
CommentstringYes

The purpose or objective of the data tracking ticket. This parameter is used to help reduce unnecessary communication.

test
RelatedUserListarrayNo

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

stringNo

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

123***
ParamobjectYes

The parameters of the ticket.

DbIdstringYes

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

Note You can call this operation to create a data tracking ticket for only physical databases. This operation is not applicable to logical databases.
123***
JobStartTimestringYes

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
JobEndTimestringYes

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
TableNamesarrayYes

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

stringNo

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

table2
TrackTypesarrayYes

The types of data operations that you want to track.

stringNo

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

  • INSERT
  • UPDATE
  • DELETE
INSERT
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

283C461F-11D8-48AA-B695-DF092DA32AF3
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
CreateOrderResultarray

The IDs of the data tracking tickets.

OrderIdslong

The ID of the data tracking ticket.

12***

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history