Queries the information about a 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.

Tid Long No 3***

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

OrderId Long Yes 420****

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

RegionId String No cn-hangzhou

The ID of the region in which Data Management (DMS) is activated. For more information, see RegionID parameter.

Response parameters

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

The ID of the request.

DataCorrectOrderDetail Object

The information about the data change ticket.

PreCheckDetail Array of TaskCheckDO

The precheck details of the ticket.

TaskCheckDO
UserTip String tip messsage

The message that indicates a check step.

CheckStatus String SUCCESS

The status of the precheck. Valid values:

  • WAITING: The ticket is pending check.
  • RUNNING: The ticket is being checked.
  • SUCCESS: The ticket passes the precheck.
  • FAIL: The ticket fails the precheck.
CheckStep String PERMISSION_CHECK

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 permission required for the data change.
  • ROW_CHECK: The system checks the number of affected rows.
OrderDetail Object

The details of the ticket.

RbSQL String empty

The SQL statements used to roll back data.

RbAttachmentName String test

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

Classify String test

The category of the reason for the data change.

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

The executed SQL statements.

EstimateAffectRows Long 100

The estimated number of affected rows.

RbSQLType String text

The type of the file that contains the SQL statements used to roll back data. Valid values:

  • TEXT: text
  • ATTACHMENT: attachment
ActualAffectRows Long 100

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

IgnoreAffectRows Boolean false

Indicates whether the precheck result is ignored. Valid values:

  • true: The precheck result is ignored.
  • false: The precheck result is not ignored.
AttachmentName String xxx

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

SqlType String text

The type of the file that contains the SQL statements used to change data. Valid values:

  • TEXT: text
  • ATTACHMENT: attachment
IgnoreAffectRowsReason String test

The reason why the precheck result is ignored.

DatabaseList Array of Database

The information about the database in which data is changed.

Database
DbId Integer 123456

The ID of the database.

DbType String mysql

The type of the database.

Logic Boolean false

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

  • true: The database is a logical database.
  • false: The database is a physical database.
SearchName String xxx@xxx:3306

The name that is used to search for the database.

EnvType String product

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
Status String approved

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.
  • processing: The ticket is being executed.
  • success: The ticket is executed.
  • closed: The ticket is closed.
ErrorCode String UnknownError

The error code returned.

ErrorMessage String UnknownError

The error message returned.

Success Boolean true

Indicates whether the request was successful. Valid values:

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

Examples

Sample request

http(s)://dms-enterprise.aliyuncs.com/?Action=GetDataCorrectOrderDetail
&Tid=3***
&OrderId=420****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetDataCorrectOrderDetailResponse>
    <RequestId>427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D</RequestId>
    <DataCorrectOrderDetail>
        <PreCheckDetail>
            <UserTip>tip messsage</UserTip>
            <CheckStatus>SUCCESS</CheckStatus>
            <CheckStep>PERMISSION_CHECK</CheckStep>
        </PreCheckDetail>
        <OrderDetail>
            <RbSQL>empty</RbSQL>
            <RbAttachmentName>test</RbAttachmentName>
            <Classify>test</Classify>
            <ExeSQL>update t1 set name = 'xxx' where id &lt;= 100</ExeSQL>
            <EstimateAffectRows>100</EstimateAffectRows>
            <RbSQLType>text</RbSQLType>
            <ActualAffectRows>100</ActualAffectRows>
            <IgnoreAffectRows>false</IgnoreAffectRows>
            <AttachmentName>xxx</AttachmentName>
            <SqlType>text</SqlType>
            <IgnoreAffectRowsReason>test</IgnoreAffectRowsReason>
        </OrderDetail>
        <DatabaseList>
            <DbId>123456</DbId>
            <DbType>mysql</DbType>
            <Logic>false</Logic>
            <SearchName>xxx@xxx:3306</SearchName>
            <EnvType>product</EnvType>
        </DatabaseList>
        <Status>success</Status>
    </DataCorrectOrderDetail>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <Success>true</Success>
</GetDataCorrectOrderDetailResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "DataCorrectOrderDetail" : {
    "PreCheckDetail" : [ {
      "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" : [ {
      "DbId" : 123456,
      "DbType" : "mysql",
      "Logic" : false,
      "SearchName" : "xxx@xxx:3306",
      "EnvType" : "product"
    } ],
    "Status" : "success"
  },
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "Success" : true
}

Error codes

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