All Products
Search
Document Center

Data Management:PauseDataCorrectSQLJob

Last Updated:Jul 15, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

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

43253
TypestringYes

The type of the pause operation. Valid values:

  • ALL: pauses all SQL tasks.
  • SINGLE: pauses a single SQL task.
SINGLE
JobIdlongNo

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
TidlongNo

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

4325

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

335C5BC8-490C-56EF-BDDE-94A4B53FEB72
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorMessagestring

The error message that is returned.

UnknownError
ErrorCodestring

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 timeSummary of changesOperation
No change history