All Products
Search
Document Center

Data Management:RestartDataCorrectSQLJob

Last Updated:Apr 26, 2024

Reruns a failed 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:RestartDataCorrectSQLJobRead
  • All Resources
    *
    none
none

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.

453****
TypestringYes

The type of the rerun operation. Valid values:

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

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

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.

43253
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

809B52F2-CD2B-53DA-88C8-F7042787E673
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrorMessagestring

The error message returned.

UnknownError
ErrorCodestring

The error code returned.

UnknownError

Examples

Sample success responses

JSONformat

{
  "RequestId": "809B52F2-CD2B-53DA-88C8-F7042787E673",
  "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
2024-02-23The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.