Call the PauseDataCorrectSQLJob API to pause a data change SQL task - Data Management - Alibaba Cloud - Data Management

Operation description

This operation is available only for database instances managed in Security Collaboration mode.

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:PauseDataCorrectSQLJob

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	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	integer	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	integer	No	The tenant ID. You can call the GetUserActiveTenant operation to query the tenant ID.	4325

Response elements

Element	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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.