All Products
Search

This Product

    Data Management:GetStructSyncJobDetail

    Document Center

    Data Management:GetStructSyncJobDetail

    Last Updated:Oct 21, 2024

    Queries the information of a schema synchronization task.

    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
    OrderIdlongYes

    The ticket ID.

    		4324321
    TidlongNo

    The tenant ID.

    Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.
    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		48602B78-0DDF-414C-8688-70CAB6070115
    Successboolean

    Indicates whether the request was successful.

    		true
    ErrorMessagestring

    The error message.

    		UnknownError
    ErrorCodestring

    The error code.

    		UnknownError
    StructSyncJobDetailobject

    The details of the schema synchronization task.

    JobStatusstring

    The status of the task. Valid values:

    • NEW: The task was created.
    • COMPARING: The schemas of tables were being compared.
    • COMPARE_BREAK: The schema comparison was interrupted.
    • COMPARE_FINISH: The comparison was finished.
    • NOT_SCRIPTS: The comparison was finished but no executable script was available.
    • SUBMITED_DBTASK: The task was submitted.
    • DBTASK_SUCCESS: The task was complete.
    • SUBMITED_WORKFLOW: The ticket was submitted.
    • WORKFLOW_SUCCESS: The ticket was approved.
    		DBTASK_SUCCESS
    Messagestring

    The description of the task.

    		test
    TableAnalyzedlong

    The number of tables that have been analyzed.

    		2
    TableCountlong

    The total number of tables.

    		2
    SqlCountlong

    The total number of SQL statements.

    		1
    ExecuteCountlong

    The number of SQL statements that have been executed.

    		1
    SecurityRulestring

    The type of security rule. Valid values:

    • CANNOT_SYNC: Synchronization cannot be performed.
    • WITH_APPROVE: The schema synchronization can be performed after the ticket is approved. You can call the SubmitStructSyncOrderApproval operation to submit the ticket for approval.
    • WITHOUT_APPROVE: The schema synchronization can be performed without approval.
    		WITHOUT_APPROVE
    DBTaskGroupIdlong

    The ID of the SQL task group.

    		12345

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncJobDetail": {
    "JobStatus": "DBTASK_SUCCESS",
    "Message": "test",
    "TableAnalyzed": 2,
    "TableCount": 2,
    "SqlCount": 1,
    "ExecuteCount": 1,
    "SecurityRule": "WITHOUT_APPROVE",
    "DBTaskGroupId": 12345
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history