Help Center/ Server Migration Service/ API Reference/ API/ Source Server Management/ Updating the Migration Task Status of a Source Server
Updated on 2025-09-16 GMT+08:00
View PDF

Updating the Migration Task Status of a Source Server

Function

This API is used to update the migration task status of a source server.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/sources/{source_id}/changestate

Table 1 Path parameter

Parameter

Mandatory

Type

Description

source_id

Yes

String

The ID of the source server in SMS.

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

copystate

No

String

The source server status.

UNAVAILABLE: The source server fails the environment check.

WAITING: The source server is waiting for migration.

INIT: The migration of the source server is being initialized.

REPLICATE: The source server is being replicated.

SYNCING: The source server is being synchronized.

STOPPING: The migration of the source server is being stopped.

STOPPED: The migration of the source server is stopped.

DELETING: The source server record is being deleted.

ERROR: An error occurs during the migration of the source server.

CLONING: The target server for the source server is being cloned.

CUTOVERING: The target server for the source server is being launched.

FINISHED: The target server for the source server is launched.

The value can be:

  • UNAVAILABLE

  • WAITING

  • INIT

  • REPLICATE

  • SYNCING

  • STOPPING

  • STOPPED

  • DELETING

  • ERROR

  • CLONING

  • CUTOVERING

migrationcycle

No

String

The current migration stage of the source server.

cutovering: The target server for the source server is being launched.

cutovered: The target server for the source server is launched.

checking: The check is in progress.

setting: The configuration is in progress.

replicating: The data is being replicated.

syncing: The incremental data is being synchronized.

The value can be:

  • cutovering

  • cutovered

  • checking

  • setting

  • replicating

  • syncing

Response

Status code: 200

OK

None

Example Request

This example changes the migration status for source server dcdbe339-b02d-4578-95a1-9c9c547dxxxx.

PUT https://{endpoint}/v3/sources/dcdbe339-b02d-4578-95a1-9c9c547dxxxx/changestate

{
  "copystate" : "WAITING",
  "migrationcycle" : "cutovered"
}

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

For details, see Error Codes.

Parent topic: Source Server Management