Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Backup Migration/ Modifying Backup Migration Task Details
Updated on 2025-08-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying Backup Migration Task Details

Function

Thi API is used to modify the information, name, and description of a specified backup migration task.

URI

PUT /v5/{project_id}/backup-migration-jobs/{job_id}

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.

job_id

Yes

String

ID of a backup migration task.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of a request body. Use the default value application/json. 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 request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

  • en-us: English
  • zh-cn: Chinese
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of a backup migration task.

description

No

String

Description of a backup migration task.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Modifying details about a backup migration task

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs/341de3a3-c58a-445d-82e3-8e062b6jb703

{
  "name" : "new_name",
  "description": "New description"
}

Example Response

Status code: 200

OK

{ }

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000010",
  "error_msg" : "Job does not exist, please check job ID."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Backup Migration