All Products
Search

This Product

    Data Management:GetDataCorrectOrderDetail

    Document Center

    Data Management:GetDataCorrectOrderDetail

    最終更新日:Oct 21, 2024

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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

    The response parameters.

    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.

    TaskCheckDOobject
    UserTipstring

    The message that appears when a check step is executed.

    		tip messsage
    CheckStatusstring

    The state 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.

    Databaseobject
    DbIdinteger

    The database ID.

    		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: pre-release environment.
    • test: test environment.
    • sit: system integration testing (SIT) environment
    • uat: user acceptance testing (UAT) environment.
    • pet: stress testing environment.
    • stag: staging environment.
    		product
    Statusstring

    The specific state of the data change ticket. Valid values:

    Note The state of the ticket is not exactly equivalent to the status code for the ticket. To query the status code of the ticket, you can call the GetOrderBaseInfo operation and check the value of StatusCode in the response.
    • new: The ticket is created.
    • precheck: The ticket is in the pre-check phase.
    • precheckFailed: The ticket failed to pass 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 task is submitted and waits to be scheduled.
    • processing: The task is being executed.
    • Success: The task is successful.
    		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
    ConfigDetailobject

    The configurations of the ticket. This parameter is used to store the configuration information specific to a data change ticket type.

    DetailTypestring

    The type of the ticket. Valid values:

    • COMMON: regular data change.
    • CHUNK_DML: lock-free data change.
    • BIG_FILE: large data import.
    • CRON_CLEAR_DATA: historical data cleanup.
    • PROCEDURE: programmable object change.
    		BIG_FILE
    FileTypestring

    The type of the file to be imported. This parameter is valid if the value of DetailType is BIG_FILE. Valid values:

    • SQL: an SQL file.
    • CSV: a CSV file.
    • EXCEL: an Excel file.
    • JSON: a JSON file, which is supported only by MongoDB databases.
    		CSV
    CsvTableNamestring

    The name of the table to which data is to be imported. This parameter is valid only if the value of DetailType is BIG_FILE. If the value of FileType is SQL, this parameter is empty.

    		tb_import_tb_name
    FileEncodingstring

    The encoding method of the file. This parameter may be empty, which indicates the value of AUTO. Valid values:

    • AUTO: automatic identification.
    • UTF-8: UTF-8 encoding.
    • GBK: GBK encoding.
    • ISO-8859-1: ISO-8859-1 encoding.
    		UTF-8
    Cronboolean

    Indicates whether the task is a scheduled task for historical data cleanup. This parameter is a reserved parameter and is valid only if the value of DetailType is CRON_CLEAR_DATA.

    		true
    CronCallTimesinteger

    The number of times the scheduled task is run. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA.

    		0
    CronFormatstring

    The CRON expression of the scheduled task. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA.

    		0 0 2 * * ?
    Durationinteger

    The execution duration of the scheduled task. Unit: hour. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA. If the value is greater than 0, an execution duration is set.

    		1
    CronStatusstring

    The state of the scheduled task. If this parameter is empty, the task is not run. Valid values:

    • PAUSE: The task is suspended.
    • WAITING: The task is waiting to be run.
    • SUCCESS: The task is run.
    		SUCCESS
    CronLastCallStartTimestring

    The time when the task was last run.

    		2024-04-19 02:00:00.0
    CronNextCallTimestring

    The time when the task is run next time. This parameter is returned only if the value of CronStatus is SUCCESS.

    		2024-04-19 02:00:00
    CurrentTaskIdlong

    The ID of the current data change task. This is a reserved parameter and can be ignored.

    		13***
    ImportExtConfigobject

    The additional configuration information about data import. This parameter is valid if the value of DetailType is BIG_FILE.

    InsertTypestring

    The mode in which data is to be imported to the destination table. Valid values:

    • INSERT: The database checks the primary key during data insertion. If the primary key is duplicated, an error is reported.
    • INSERT_IGNORE: If the imported data contains data records that are the same as those in the destination table, the new data records are ignored.
    • REPLACE_INTO: If the imported data contains a row that has the same value for the primary key or unique index as an existing row in the destination table, the system deletes the existing row and inserts the new row into the destination table.
    Note This parameter is valid if the value of FileType is CSV or EXCEL.
    		INSERT
    CsvFirstRowIsColumnDefboolean

    Indicates whether the first row of the CSV file contains field names. Valid values:

    • true: The first row in the CSV file contains field names.
    • false: The first row in the CSV file contains data.
    Note This parameter is valid if the value of FileType is CSV or EXCEL.
    		true
    IgnoreErrorboolean

    Indicates whether an error that occurs is ignored. Valid values:

    • true: If an error occurs when SQL statements are being executed, DMS skips the current SQL statement and continues to execute subsequent SQL statements.
    • false: If an error occurs when SQL statements are being executed, DMS stops executing subsequent SQL statements.
    		false
    ImportModestring

    The import mode. Valid values:

    • FAST_MODE: fast mode. In the Execute step, the uploaded file is read and SQL statements are executed to import data to the specified destination database. Compared with the security mode, this mode can be used to import data in a less secure but more efficient manner.
    • SAFE_MODE: security mode. In the Precheck step, the uploaded file is parsed, and SQL statements or CSV file data is cached. In the Execute step, the cached SQL statements are read and executed to import data, or the cached CSV file data is read and imported to the specified destination database. Compared with the fast mode, this mode can be used to import data in a more secure but less efficient manner.
    		FAST_MODE
    CronExtConfigobject

    The additional configuration information about historical data cleanup. This parameter is valid only if the value of DetailType is CRON_CLEAR_DATA.

    OptimizeTableAfterEveryClearTimesinteger

    Indicates whether the Periodically Optimize Table feature is enabled. Valid values:

    • 0 (default): The feature is disabled.
    • A value greater than 0: The feature is enabled. The value indicates the number of cleanups after which the system performs defragmentation.
    		0
    CurrentClearTaskCountinteger

    The number of times defragmentation is performed. This parameter is valid only if the value of OptimizeTableAfterEveryClearTimes is greater than 0.

    		0
    ErrorCodestring

    The error code returned if the request fails.

    		UnknownError
    ErrorMessagestring

    The error message returned if the request fails.

    		UnknownError
    Successboolean

    Indicates whether the operation was successful. Valid values:

    • true
    • false
    		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",
    "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
}

    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