Help Center/ Data Replication Service/ API Reference/ APIs V3.0 (Deprecated)/ Public API Management/ Resuming or Retrying Tasks in Batches
Updated on 2024-08-23 GMT+08:00
View PDF

Resuming or Retrying Tasks in Batches

Function

  • This API is used to retry failed tasks.
  • You can resume a suspended task.
  • In the dual-active DR scenario, the parent task cannot call the API.

URI

POST /v3/{project_id}/jobs/batch-retry-task

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type

Default value: en-us

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

jobs

Yes

Array of objects

List of requests for resuming upload tasks in batches.

For details, see Table 4.
Table 4 Data structure description of field jobs

Parameter

Mandatory

Type

Description

job_id

Yes

String

Task ID.

is_sync_re_edit

No

Boolean

This parameter is mandatory when a task is resumed or retried and must be set to true.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

results

Array of objects

List of tasks that can be resumed in batches.

For details, see Table 6.

count

Integer

Total number.
Table 6 Data structure description of field results

Parameter

Type

Description

id

String

Task ID.

status

String

Status

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Resuming specified tasks in batches

https://{endpoint}/v3/054babbbde80d4602f5cc0043a40ed8c/jobs/batch-retry-task

{
  "jobs" : [ {
    "job_id" : "140b5236-88ad-43c8-811c-1268453jb101"
  } ]
}

Example Response

Status code: 200

OK

{
  "results" : [ {
    "id" : "140b5236-88ad-43c8-811c-1268453jb101",
    "status" : "success"
  } ],
  "count" : 1
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Public API Management