Query schema synchronization job details using GetStructSyncJobDetail - Data Management - Alibaba Cloud - Data Management

Retrieves the details of a schema synchronization task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetStructSyncJobDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID.	4324321
Tid	integer	No	The tenant ID. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	48602B78-0DDF-414C-8688-70CAB6070115
Success	boolean	Indicates whether the request was successful.	true
ErrorMessage	string	The error message.	UnknownError
ErrorCode	string	The error code.	UnknownError
StructSyncJobDetail	object	The details of the schema synchronization task.
JobStatus	string	The status of the task. Valid values: NEW: The task was created. COMPARING: Table schemas are being compared. COMPARE_BREAK: The schema comparison was interrupted. COMPARE_FINISH: The comparison is complete. NOT_SCRIPTS: The comparison is complete, but no executable script is available. SUBMITED_DBTASK: The task was submitted. DBTASK_SUCCESS: The task is complete. SUBMITED_WORKFLOW: The ticket was submitted. WORKFLOW_SUCCESS: The ticket was approved.	DBTASK_SUCCESS
Message	string	The description of the task.	test
TableAnalyzed	integer	The number of tables that have been analyzed.	2
TableCount	integer	The total number of tables.	2
SqlCount	integer	The total number of SQL statements.	1
ExecuteCount	integer	The number of SQL statements that have been executed.	1
SecurityRule	string	The type of security rule. Valid values: CANNOT_SYNC: Synchronization cannot be performed. WITH_APPROVE: Schema synchronization can be performed after the ticket is approved. You can call the SubmitStructSyncOrderApproval operation to submit the ticket for approval. WITHOUT_APPROVE: Schema synchronization can be performed without approval.	WITHOUT_APPROVE
DBTaskGroupId	integer	The ID of the SQL task group.	12345

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.