调用GetDataCorrectOrderDetail接口,获取DMS数据变更工单详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetDataCorrectOrderDetail

系统规定参数。取值:GetDataCorrectOrderDetail。

Tid Long 否 3***

租户ID,可通过调用接口GetUserActiveTenant或ListUserTenants获取该参数的值。

OrderId Long 是 420****

工单ID,可通过调用接口ListOrders获取该参数的值。

RegionId String 否 cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明。

返回数据

名称 类型 示例值 描述
RequestId String 427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D

请求ID。

DataCorrectOrderDetail Object

数据变更工单详情信息。

PreCheckDetail Array of TaskCheckDO

预校验详情信息列表。

TaskCheckDO
UserTip String tip messsage

校验步骤提示信息。

CheckStatus String SUCCESS

预校验状态,返回值如下:

  • WAITING:等待检查
  • RUNNING:检查中
  • SUCCESS:通过
  • FAIL:不通过
CheckStep String PERMISSION_CHECK

检查步骤,返回值如下:

  • SQL_PARSE:解析
  • SQL_TYPE_CHECK:类型检查
  • PERMISSION_CHECK:权限检查
  • ROW_CHECK:行数检查
OrderDetail Object

工单详情信息。

RbSQL String empty

回滚SQL。

RbAttachmentName String test

回滚SQL附件。

Classify String test

变更原因分类。

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

执行的SQL语句。

EstimateAffectRows Long 100

预估影响行数 。

RbSQLType String text

回滚SQL类型,返回值如下:

  • TEXT:文本
  • ATTACHMENT:附件
ActualAffectRows Long 100

系统校验的影响行数。

IgnoreAffectRows Boolean false

是否忽略预校验,返回值如下:

  • true:忽略预校验
  • false:不忽略预校验
AttachmentName String xxx

SQL附件。

SqlType String text

SQL类型,返回值如下:

  • TEXT:文本
  • ATTACHMENT:附件
IgnoreAffectRowsReason String test

忽略预校验原因。

DatabaseList Array of Database

变更库信息列表。

Database
DbId Integer 1860****

数据库ID。

DbType String mysql

数据库类型。

Logic Boolean false

是否为逻辑库,返回值如下:

  • true:逻辑库
  • false:物理库
SearchName String xxx@xxx:3306

数据库搜索名。

EnvType String product

环境类型,返回值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT环境
  • uat:UAT环境
  • pet:压测环境
  • stag:STAG环境
Status String approved

工单状态,返回值如下:

  • new:新建
  • precheck:预检查阶段
  • precheck_fail:预检查失败
  • precheck_success:预检查成功, 等待提交审批。
  • toaudit:审批中
  • approved:审批通过
  • reject:审批拒绝
  • waiting:任务已提交,待调度处理。
  • processing:执行中
  • success:执行成功
  • closed:已关闭
ExecMode String COMMITOR

工单执行方式,返回值如下:

  • COMMITOR : 审批通过后,提交者执行。
  • AUTO : 审批通过后,自动执行。
  • LAST_AUDITOR : 审批通过后,最后一个审批人执行。
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetDataCorrectOrderDetail
&Tid=3***
&OrderId=420****
&公共请求参数

正常返回示例

XML格式

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>1860****</DbId>
            <DbType>mysql</DbType>
            <Logic>false</Logic>
            <SearchName>xxx@xxx:3306</SearchName>
            <EnvType>product</EnvType>
        </DatabaseList>
        <Status>approved</Status>
        <ExecMode>COMMITOR</ExecMode>
    </DataCorrectOrderDetail>
    <Success>true</Success>
</GetDataCorrectOrderDetailResponse>

JSON格式

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" : "1860****",
      "DbType" : "mysql",
      "Logic" : false,
      "SearchName" : "xxx@xxx:3306",
      "EnvType" : "product"
    } ],
    "Status" : "approved",
    "ExecMode" : "COMMITOR"
  },
  "Success" : true
}

错误码

访问错误中心查看更多错误码。