GetDataCorrectOrderDetail - 获取数据变更工单详细信息 - 数据管理 DMS

获取数据变更工单详细信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetDataCorrectOrderDetail	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。	3***
OrderId	long	是	工单 ID，可通过调用接口 ListOrders 获取该参数的值。	420****

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
DataCorrectOrderDetail	object	数据变更工单详情信息。
PreCheckDetail	array<object>	预校验详情信息列表。
TaskCheckDO	object	预校验详情信息。
UserTip	string	校验步骤提示信息。	tip messsage
CheckStatus	string	预校验状态，返回值如下： WAITING：等待检查 RUNNING：检查中 SUCCESS：通过 FAIL：不通过	SUCCESS
CheckStep	string	检查步骤，返回值如下： SQL_PARSE：解析 SQL_TYPE_CHECK：类型检查 PERMISSION_CHECK：权限检查 ROW_CHECK：行数检查	PERMISSION_CHECK
OrderDetail	object	工单详情信息。
RbSQL	string	回滚 SQL。	empty
RbAttachmentName	string	回滚 SQL 附件。	test
Classify	string	变更原因分类。	test
ExeSQL	string	执行的 SQL 语句。	update t1 set name = 'xxx' where id <= 100
EstimateAffectRows	long	预估影响行数。	100
RbSQLType	string	回滚 SQL 类型，返回值如下： TEXT：文本 ATTACHMENT：附件	text
ActualAffectRows	long	系统校验的影响行数。	100
IgnoreAffectRows	boolean	是否忽略预校验，返回值如下： true：忽略预校验 false：不忽略预校验	false
AttachmentName	string	SQL 附件。	xxx
SqlType	string	SQL 类型，返回值如下： TEXT：文本 ATTACHMENT：附件	text
IgnoreAffectRowsReason	string	忽略预校验原因。	test
DatabaseList	array<object>	变更库信息列表。
Database	object
DbId	integer	数据库 ID。	1860****
DbType	string	数据库类型。	mysql
Logic	boolean	是否为逻辑库，返回值如下： true：逻辑库。 false：物理库。	false
SearchName	string	数据库搜索名。	xxx@xxx:3306
EnvType	string	环境类型，返回值如下： product：生产环境 dev：开发环境 pre：预发环境 test：测试环境 sit：SIT 环境 uat：UAT 环境 pet：压测环境 stag：STAG 环境	product
Status	string	数据变更工单特有的状态，返回值如下：说明此状态与工单状态码不完全等价，若需要得到工单状态，请通过 GetOrderBaseInfo 返回的 StatusCode 属性获取。 new：新建。 precheck：预检查阶段。 precheck_fail：预检查失败。 precheck_success：预检查成功, 等待提交审批。 toaudit：审批中。 approved：审批通过。 reject：审批拒绝。 waiting：任务已提交，待调度处理。 processing：执行中。 success：执行成功。	approved
ExecMode	string	工单执行方式，返回值如下： COMMITOR : 审批通过后，提交者执行。 AUTO : 审批通过后，自动执行。 LAST_AUDITOR : 审批通过后，最后一个审批人执行。	COMMITOR
ConfigDetail	object	工单配置信息，主要用于存储不同数据变更工单类型的差异化配置信息。
DetailType	string	标识变更工单信息类型，取值和说明如下： COMMON：普通数据变更。 CHUNK_DML：无锁变更。 BIG_FILE：数据导入。 CRON_CLEAR_DATA：历史数据清理。 PROCEDURE：可编程对象。	BIG_FILE
FileType	string	当 DetailType 为 BIG_FILE 时，标识数据导入的文件类型，取值如下： SQL：SQL 文件。 CSV：CSV 文件。 EXCEL：Excel 文件。 JSON：JSON 文件，仅 MongoDB 支持。	CSV
CsvTableName	string	数据导入表名，仅当 DetailType 为 BIG_FILE 时有效，若 FileType 取值为 SQL，则此属性为空。	tb_import_tb_name
FileEncoding	string	文件编码，注意取值可能为空，为空则代表 AUTO，取值如下： AUTO：自动识别 UTF-8：UTF8 编码 GBK：GBK 编码 ISO-8859-1：ISO-8859-1 编码	UTF-8
Cron	boolean	是否为历史数据清理定时任务，预留字段，当且仅当 DetailType 为 CRON_CLEAR_DATA 有效。	true
CronCallTimes	integer	当 DetailType 为 CRON_CLEAR_DATA 时有效，表示已调度次数。	0
CronFormat	string	当 DetailType 为 CRON_CLEAR_DATA 时有效，表示定时任务 Cron 表达式。	0 0 2 * * ?
Duration	integer	当 DetailType 为 CRON_CLEAR_DATA 时有效，表示定时清理执行时长，单位为小时。当取值大于 0，表示设置了清理时长。	1
CronStatus	string	定时任务状态，为空表示未调度，其他取值和说明如下： PAUSE：调度暂停。 WAITING：待调度。 SUCCESS：调度完成。	SUCCESS
CronLastCallStartTime	string	最近一次调度时间。	2024-04-19 02:00:00.0
CronNextCallTime	string	下一次调度时间。仅当调度状态为 SUCCESS 时才会有显示。	2024-04-19 02:00:00
CurrentTaskId	long	当前数据变更任务 ID，保留字段，业务暂时不依赖。	13***
ImportExtConfig	object	当 DetailType 为 BIG_FILE，即为数据导入工单时，此处提供数据导入附加配置信息。
InsertType	string	插入类型，取值如下： INSERT：插入数据时数据库会检查主键（PrimaryKey），如果出现重复会报错。 INSERT_IGNORE：如果表中已经存在相同的记录，则忽略当前新数据。 REPLACE_INTO：如果表中已经有某行数据（根据主键或者唯一索引判断），则先删除此行数据，然后插入新的数据。说明如果 FileType 为 CSV 或者为 EXCEL，该参数有效。	INSERT
CsvFirstRowIsColumnDef	boolean	CSV 格式的类型，取值如下： true：CSV 表格首行是字段名。 false：CSV 表格首行是数据。说明如果 FileType 为 CSV 或者为 EXCEL，该参数有效。	true
IgnoreError	boolean	是否忽略报错，取值： true：忽略，遇到错误会跳过当前失败 SQL 脚本，继续执行。 false：不忽略，遇到出错则中断后面的 SQL 脚本，不再执行。	false
ImportMode	string	导入模式，取值如下： FAST_MODE：极速模式，在执行阶段读取文件，将 SQL 语句直接执行到指定的目标库。该模式安全性相比安全模式要低，但是执行时效较高。 SAFE_MODE：安全模式，在预检查阶段会解析文件并将 SQL 或 CSV 数据缓存入库，执行时再从缓存库中读出来执行到指定的目标库。该模式安全性较好，但是执行时效相比极速模式要低。	FAST_MODE
CronExtConfig	object	当且仅当 DetailType 为 CRON_CLEAR_DATA，即为历史数据清理工单时，此处提供历史数据清理额外配置信息。
OptimizeTableAfterEveryClearTimes	integer	是否启用自动 Optimize table，取值： 0：不启用。大于 0：启用，表示每隔多少次清理以后再进行 Optimize table。	0
CurrentClearTaskCount	integer	已进行自动 optimize table 的次数。仅当 OptimizeTableAfterEveryClearTimes 大于 0 时有效。	0
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "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",
    "ConfigDetail": {
      "DetailType": "BIG_FILE",
      "FileType": "CSV",
      "CsvTableName": "tb_import_tb_name",
      "FileEncoding": "UTF-8",
      "Cron": true,
      "CronCallTimes": 0,
      "CronFormat": "0 0 2 * * ?",
      "Duration": 1,
      "CronStatus": "SUCCESS",
      "CronLastCallStartTime": "2024-04-19 02:00:00.0",
      "CronNextCallTime": "2024-04-19 02:00:00\n",
      "CurrentTaskId": 0,
      "ImportExtConfig": {
        "InsertType": "INSERT",
        "CsvFirstRowIsColumnDef": true,
        "IgnoreError": false,
        "ImportMode": "FAST_MODE"
      },
      "CronExtConfig": {
        "OptimizeTableAfterEveryClearTimes": 0,
        "CurrentClearTaskCount": 0
      }
    }
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-18	OpenAPI 返回结构发生变更	查看变更详情
2024-04-18	OpenAPI 返回结构发生变更	查看变更详情