Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Management of Tasks Created Asynchronously in Batches/ Exporting a Task Creation Template
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Exporting a Task Creation Template

Function

This API is used to export a template based on an existing task. (This is an asynchronous operation. You need to call the API for querying the export progress to query the result.)

URI

POST /v5/{project_id}/jobs/export/template

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

MIME type of the request body. The default value application/json is recommended. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a response is returned, the value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

jobs

Yes

Array of strings

ID list of tasks to be exported.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

id

String

Asynchronous ID.

status

String

Status.

Example Request

Exporting a template based on an existing task

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/export/template

{
  "jobs" : [ "2e69ebb1-f06d-4eb2-a789-2883629jb204" ]
}

Example Response

Status code: 202

Accepted

{
  "id" : "62a055ae-ce03-4232-beb6-46c83b8ef2b2",
  "status" : "SUCCESS"
}

Status Code

Status Code

Description

202

Accepted

Error Code

For details, see Error Code.