All Products
Search
Document Center

Data Management:GetDataCorrectOrderDetail

Last Updated:Jul 15, 2024

Queries the information about a data change ticket in Data Management (DMS).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

3***
OrderIdlongYes

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

420****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
DataCorrectOrderDetailobject

The information about the data change ticket.

PreCheckDetailarray<object>

The precheck details of the ticket.

object
UserTipstring

The message that indicates a check step.

tip messsage
CheckStatusstring

The status of the precheck. Valid values:

  • WAITING: The ticket is pending precheck.
  • RUNNING: The ticket is being prechecked.
  • SUCCESS: The ticket passes the precheck.
  • FAIL: The ticket fails the precheck.
SUCCESS
CheckStepstring

The check step of the precheck. Valid values:

  • SQL_PARSE: The system checks the syntax of the SQL statement.
  • SQL_TYPE_CHECK: The system checks the type of the SQL statement.
  • PERMISSION_CHECK: The system checks the permissions required for the data change.
  • ROW_CHECK: The system checks the number of affected rows.
PERMISSION_CHECK
OrderDetailobject

The details of the ticket.

RbSQLstring

The SQL statements used to roll back the data change.

empty
RbAttachmentNamestring

The name of the attachment that contains the SQL statements used to roll back the data change.

test
Classifystring

The category of the reason for the data change.

test
ExeSQLstring

The executed SQL statements.

update t1 set name = 'xxx' where id <= 100
EstimateAffectRowslong

The estimated number of affected rows.

100
RbSQLTypestring

The format of the SQL statements used to roll back the data change. Valid values:

  • TEXT: text
  • ATTACHMENT: attachment
text
ActualAffectRowslong

The number of affected rows that is obtained by the precheck.

100
IgnoreAffectRowsboolean

Indicates whether the precheck result is ignored. Valid values:

  • true: The precheck result is ignored.
  • false: The precheck result is not ignored.
false
AttachmentNamestring

The name of the attachment that contains the SQL statements used to change data.

xxx
SqlTypestring

The format of the SQL statements used to change data. Valid values:

  • TEXT: text
  • ATTACHMENT: attachment
text
IgnoreAffectRowsReasonstring

The reason why the precheck result is ignored.

test
DatabaseListarray<object>

The information about the database in which data is changed.

object
DbIdinteger

The ID of the database.

1860****
DbTypestring

The engine of the database.

mysql
Logicboolean

Indicates whether the database is a logical database. Valid values:

  • true: The database is a logical database.
  • false: The database is a physical database.
false
SearchNamestring

The name that is used to search for the database.

xxx@xxx:3306
EnvTypestring

The type of the environment to which the database belongs. Valid values:

  • product: production environment
  • dev: development environment
  • pre: staging environment
  • test: test environment
  • sit: system integration testing (SIT) environment
  • uat: user acceptance testing (UAT) environment
  • pet: stress testing environment
  • stag: STAG environment
product
Statusstring

The status of the ticket. Valid values:

  • new: The ticket is created.
  • precheck: The ticket is being prechecked.
  • precheck_fail: The ticket fails the precheck.
  • precheck_success: The ticket passes the precheck and waits to be submitted for approval.
  • toaudit: The ticket is being reviewed.
  • Approved: The ticket is approved.
  • reject: The ticket is rejected.
  • waiting: The ticket is submitted and waits to be scheduled.
  • processing: The ticket is being executed.
  • success: The ticket is executed.
  • closed: The ticket is closed.
approved
ExecModestring

The execution mode of the ticket after the ticket is approved. Valid values:

  • COMMITOR: The data change is performed by the user who submits the ticket.
  • AUTO: The data change is automatically performed after the ticket is approved.
  • LAST_AUDITOR: The data change is performed by the last approver of the ticket.
COMMITOR
ErrorCodestring

The error code returned if the request fails.

UnknownError
ErrorMessagestring

The error message returned if the request fails.

UnknownError
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataCorrectOrderDetail": {
    "PreCheckDetail": {
      "TaskCheckDO": [
        {
          "UserTip": "tip messsage",
          "CheckStatus": "SUCCESS",
          "CheckStep": "PERMISSION_CHECK"
        }
      ]
    },
    "OrderDetail": {
      "RbSQL": "empty",
      "RbAttachmentName": "test",
      "Classify": "test",
      "ExeSQL": "update t1 set name = 'xxx' where id <= 100",
      "EstimateAffectRows": 100,
      "RbSQLType": "text",
      "ActualAffectRows": 100,
      "IgnoreAffectRows": false,
      "AttachmentName": "xxx",
      "SqlType": "text",
      "IgnoreAffectRowsReason": "test"
    },
    "DatabaseList": {
      "Database": [
        {
          "DbId": 0,
          "DbType": "mysql",
          "Logic": false,
          "SearchName": "xxx@xxx:3306",
          "EnvType": "product"
        }
      ]
    },
    "Status": "approved",
    "ExecMode": "COMMITOR"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-04-18The response structure of the API has changedView Change Details
2024-04-18The response structure of the API has changedView Change Details