Pauses an SQL task for data change.

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
Action String Yes PauseDataCorrectSQLJob

The operation that you want to perform. Set the value to PauseDataCorrectSQLJob.

OrderId Long Yes 43253

The ID of the data change ticket. You can call the ListOrders operation to query the ID of the data change ticket.

Type String Yes SINGLE

The type of the pause operation. Valid values:

  • ALL: pauses all SQL tasks.
  • SINGLE: pauses a single SQL task.
JobId Long No 43253

The ID of the SQL task. You can call the GetDataCorrectTaskDetail and ListDBTaskSQLJob operations to obtain the value of this parameter.

Note If the Type parameter is set to SINGLE, you must pass the value of the JobId parameter to confirm the ID of the SQL task that you want to rerun.
Tid Long No 4325

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

RegionId String No cn-hangzhou

The ID of the region in which Data Management (DMS) is activated. Set this parameter to the ID of the region that is in proximity to your applications. For more information about the valid values of this parameter, see RegionID parameter.

Response parameters

Parameter Type Example Description
RequestId String 335C5BC8-490C-56EF-BDDE-94A4B53FEB72

The ID of the request.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
ErrorMessage String UnknownError

The error message returned.

ErrorCode String UnknownError

The error code returned.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=PauseDataCorrectSQLJob
&OrderId=453****
&Type=ALL
&JobId=43253
&Tid=3***
&<Common request parameters>

Sample success responses

XML format

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

<PauseDataCorrectSQLJobResponse>
    <RequestId>335C5BC8-490C-56EF-BDDE-94A4B53FEB72</RequestId>
    <Success>true</Success>
</PauseDataCorrectSQLJobResponse>

JSON format

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

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

Error codes

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