You can call this operation to query detailed information of a specified data change ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetDataCorrectOrderDetail

The operation that you want to perform. Set the value to GetDataCorrectOrderDetail.

OrderId Long   Yes 12345

The ID of the ticket.

Tid Long No -1

The ID of the tenant.

Response parameters

Parameter Type Example Description
RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

ErrorMessage String UnknownError

Error message

ErrorCode String UnknownError

Error code

DataCorrectOrderDetail Struct

The detailed information of the data change ticket.

PreCheckDetail Array

The details of the precheck task.

CheckStatus String SUCCESS

The status of the precheck task. Valid values:

  • WAITING: The ticket was waiting for precheck.
  • RUNNING: The ticket was being prechecked.
  • SUCCESS: The ticket was successfully prechecked.
  • FAIL: The ticket failed to be prechecked.
CheckStep String PERMISSION_CHECK

The check step. Valid values:

  • SQL_PARSE: parsing
  • SQL_TYPE_CHECK: type check
  • PERMISSION_CHECK: permission check
  • ROW_CHECK: row check
UserTip String tip message

The message that indicated a check step.

DatabaseList Array

Modify database information

SearchName String xxx@xxx:3306

The query name of the database.

EnvType String product

The type of the environment to which the database instance belongs.

DbType String mysql

The type of the database instance.

DbId Integer 123456

The ID of the database.

Logic Boolean  false

Indicates whether the database was a logical database.

OrderDetail Struct

The detailed information of the ticket.

Classify String test

The category of the reason for data change.

EstimateAffectRows Long 1,000

The estimated number of affected rows.

ActualAffectRows Long 1,000

The number of affected rows detected by system check.

IgnoreAffectRows Boolean  false

Indicates whether the affected rows were ignored.

IgnoreAffectRowsReason String test

The reason that the affected rows were ignored.

SqlType String test

The type of the SQL file that was run to change data. Valid values:

  • TEXT
  • ATTACHMENT
ExeSQL String update t1 set name = 'xxx' where id <= 100

The SQL statement that was run to change data.

AttachmentName String xxx

The attachment of the SQL statement that was run to change data.

RbSQLType String test

The type of the SQL file that was run to roll back data. Valid values:

  • TEXT
  • ATTACHMENT
RbSQL String empty

The SQL statement that was run to roll back data.

RbAttachmentName String test

The attachment of the SQL statement that was run to roll back data.

Examples

Sample request

http(s)://[Endpoint]/? Action=GetDataCorrectOrderDetail
&OrderId=12345
&<Common request parameters>

Sample success responses

XML format

<RequestId>ACE263E5-CF5F-44DD-A7B1-42C5E78E9650</RequestId>
<DataCorrectOrderDetail>
    <PreCheckDetail>
        <TaskCheckDO>
            <CheckStatus>SUCCESS</CheckStatus>
            <CheckStep>SQL_PARSE</CheckStep>
        </TaskCheckDO>
        <TaskCheckDO>
            <CheckStatus>SUCCESS</CheckStatus>
            <CheckStep>SQL_TYPE_CHECK</CheckStep>
        </TaskCheckDO>
        <TaskCheckDO>
            <CheckStatus>SUCCESS</CheckStatus>
            <CheckStep>PERMISSION_CHECK</CheckStep>
        </TaskCheckDO>
        <TaskCheckDO>
            <CheckStatus>SUCCESS</CheckStatus>
            <UserTip>The system statistics. The actual number of affected rows is subject to the SQL statement that is run. </UserTip>
            <CheckStep>ROW_CHECK</CheckStep>
        </TaskCheckDO>
    </PreCheckDetail>
    <OrderDetail>
        <ActualAffectRows>0</ActualAffectRows>
        <RbSQLType>TEXT</RbSQLType>
        <ExeSQL>update base_user set id = 1 where id = 1;</ExeSQL>
        <EstimateAffectRows>1</EstimateAffectRows>
        <SqlType>TEXT</SqlType>
        <Classify>test</Classify>
        <IgnoreAffectRowsReason/>
    </OrderDetail>
</DataCorrectOrderDetail>
<Success>true</Success>

JSON format

{
  "RequestId": "ACE263E5-CF5F-44DD-A7B1-42C5E78E9650",
  "DataCorrectOrderDetail": {
    "PreCheckDetail": {
      "TaskCheckDO": [
        {
          "CheckStatus": "SUCCESS",
          "CheckStep": "SQL_PARSE"
        },
        {
          "CheckStatus": "SUCCESS",
          "CheckStep": "SQL_TYPE_CHECK"
        },
        {
          "CheckStatus": "SUCCESS",
          "CheckStep": "PERMISSION_CHECK"
        },
        {
          "CheckStatus": "SUCCESS",
          "UserTip": "The system Statistics. The actual number of affected rows is subject to the SQL statement that is run. ",
          "CheckStep": "ROW_CHECK"
        }
      ]
    },
    "OrderDetail": {
      "ActualAffectRows": 0,
      "RbSQLType": "TEXT",
      "ExeSQL": "update base_user set id = 1 where id = 1;",
      "EstimateAffectRows": 1,
      "SqlType": "TEXT",
      "Classify": "test",
      "IgnoreAffectRowsReason": ""
    }
  },
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.