Help Center/ Server Migration Service/ API Reference/ API/ Task Management/ Unlocking a Target Server
Updated on 2025-09-16 GMT+08:00
View PDF

Unlocking a Target Server

Function

This API is used to unlock the target server in a migration task.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/{task_id}/unlock

Table 1 Path parameter

Parameter

Mandatory

Type

Description

task_id

Yes

String

The task ID.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum length: 1 character

Maximum length: 16,384 characters

Response

Status code: 200

OK

None

Example Request

This example unlocks the target server in the task with ID 7a9a9540-ff28-4869-b9e4-855fbe12e83b.

POST         https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12e83b/unlock

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

For details, see Error Codes.

Parent topic: Task Management