Queries the details of a schema synchronization task.

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
OrderId Long Yes 4324321

The ID of the ticket.

Tid Long No 1

The ID of the tenant.

Note The ID of the tenant is displayed when you move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Tenant information.
RegionId String No cn-hangzhou

The ID of the region where the DMS service resides. For more information about the valid values of this parameter, see RegionID parameter.

Note Set this parameter to the ID of the region that is close to your services.

Response parameters

Parameter Type Example Description
RequestId String 48602B78-0DDF-414C-8688-70CAB6070115

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

ErrorMessage String UnknownError

The error message that is returned.

ErrorCode String UnknownError

The error code that is returned.

StructSyncJobDetail object

The details of the schema synchronization task.

JobStatus String DBTASK_SUCCESS

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 schema comparison was complete.
  • NOT_SCRIPTS: The schema comparison was complete. No scripts were available.
  • SUBMITED_DBTASK: The task was submitted.
  • DBTASK_SUCCESS: The task was complete.
  • SUBMITED_WORKFLOW: The ticket was submitted for approval.
  • WORKFLOW_SUCCESS: The ticket was approved.
Message String test

The description of the task.

TableAnalyzed Long 2

The number of tables that have been analyzed.

TableCount Long 2

The total number of tables.

SqlCount Long 1

The total number of SQL statements.

ExecuteCount Long 1

The number of SQL statements that have been executed.

SecurityRule String WITHOUT_APPROVE

The type of security rule. Valid values:

  • CANNOT_SYNC: The schema synchronization is not allowed.
  • 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.
DBTaskGroupId Long 12345

The ID of the task queue.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?OrderId=4324321
&Tid=1
&<Common request parameters>

Sample success responses

XML format 

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

<GetStructSyncJobDetailResponse>
    <RequestId>C29D0A5F-BB9B-4CB9-A6B7-19B5433983CA</RequestId>
    <StructSyncJobDetail>
        <JobStatus>COMPARE_FINISH</JobStatus>
        <Message>The schema comparison is complete. A script to synchronize the schemas of tables is generated.</Message>
        <TableAnalyzed>6</TableAnalyzed>
        <TableCount>6</TableCount>
        <SecurityRule>WITH_APPROVE</SecurityRule>
        <DBTaskGroupId>3000000</DBTaskGroupId>
    </StructSyncJobDetail>
    <Success>true</Success>
</GetStructSyncJobDetailResponse>

JSON format 

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

{
  "RequestId" : "C29D0A5F-BB9B-4CB9-A6B7-19B5433983CA",
  "StructSyncJobDetail" : {
    "JobStatus" : "COMPARE_FINISH",
    "Message": "The schema comparison is complete. A script to synchronize the schemas of tables is generated.",
    "TableAnalyzed" : 6,
    "TableCount" : 6,
    "SecurityRule" : "WITH_APPROVE",
    "DBTaskGroupId" : 3000000
  },
  "Success" : true
}

Error codes

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