PauseDataCorrectSQLJob - Data Management

Pauses a SQL task for data change.

Operation description

You can call this operation only for database instances that are managed in Security Collaboration mode.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:PauseDataCorrectSQLJob	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the data change ticket. You can call the ListOrders operation to query the ID of the data change ticket.	43253
Type	string	Yes	The type of the pause operation. Valid values: ALL: pauses all SQL tasks. SINGLE: pauses a single SQL task.	SINGLE
JobId	long	No	The ID of the SQL task. You can call the GetDataCorrectTaskDetail or ListDBTaskSQLJob operation to obtain the value of this parameter. Note If Type is set to SINGLE, you must pass in the value of JobId to confirm the ID of the SQL task that you want to pause.	43253
Tid	long	No	The tenant ID. You can call the GetUserActiveTenant operation to query the tenant ID.	4325

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	335C5BC8-490C-56EF-BDDE-94A4B53FEB72
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message that is returned.	UnknownError
ErrorCode	string	The error code that is returned.	UnknownError

Examples

Sample success responses

JSONformat

{
  "RequestId": "335C5BC8-490C-56EF-BDDE-94A4B53FEB72",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history