You can call the GetStructSyncJobDetail operation to obtain the details about the task for schema synchronization.


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.


Parameter Type Is it required? Example Description
OrderId Long No 4324321

The ticket number.

Tid Long No 1

The tenant has expired.

Note The information of the tenant's chart is taken from the avatar in the upper-right corner of the system. For more information, see View tenant information .
RegionId String No cn-hangzhou

Select the service region of the destination region to call this operation. For more information about the valid values, see switchegionfigure parameter description .

Note select based on the location of the application nearby.

return data

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

The error message returned because the request already exists.

Success Boolean true

Whether the request is successful.

ErrorMessage String UnknownError

Error message.

ErrorCode String UnknownError

Error code.

StructSyncJobDetail object

The details of the schema synchronization task.


The task status. the values and descriptions are as follows:

  • NEW : newly created.
  • COMPARING : The structure is being compared.
  • COMPARE_BREAK : Compares to manual interruptions.
  • COMPARE_FINISH : The comparison is completed.
  • NOT_SCRIPTS : comparison completed. no executable script is available.
  • SUBMITED_DBTASK : Elasticsearch has been submitted.
  • DBTASK_SUCCESS : modifytaskask is successfully executed.
  • SUBMITED_WORKFLOW : submits an application for approval.
  • WORKFLOW_SUCCESS : The approval ends.
Message String test

The description of the task.

TableAnalyzed Long 2

The tables that have been analyzed.

TableCount Long 2

The total number of tables.

SqlCount Long 1

The total number of returned Alert Records.

ExecuteCount Long 1

The number of scaling groups that have been executed.

SecurityRule String WITHOUT_APPROVE

The description of the security rule. Valid values:

  • CANNOT_SYNC : synchronization is not allowed.
  • WITH_APPROVE : synchronization after approval, callable SubmitStructSyncOrderApproval The interface initiates an approval process.
  • WITHOUT_APPROVE : synchronization does not require approval.
DBTaskGroupId Long 12345

This topic describes how to configure alerts for a task group.


Sample requests

     http(s):// >rder_id=4324321&resourceid=1&public 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> Structure comparison, preview SQL that have been generated in the </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" : "structure comparison completed preview SQL that have been generated in the", "TableAnalyzed" : 6 "TableCount" : 6 "SecurityRule" : "WITH_APPROVE", "DBTaskGroupId" : 3000000} "Success" : true} 

Error code

Access error Center For more information, see error codes.