Help Center/ Server Migration Service/ API Reference/ APIs V3.0/ Source Server Management/ Updating the Migration Task Status of a Source Server
Updated on 2024-09-04 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 displayed on the SMS console.

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. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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.

The value can be:

  • UNAVAILABLE

  • WAITING

  • INIT

  • REPLICATE

  • SYNCING

  • STOPPING

  • STOPPED

  • DELETING

  • ERROR

  • CLONING

  • CUTOVERING

  • FINISHED

migrationcycle

No

String

The current migration stage of the source server.

The value can be:

  • cutovering

  • cutovered

  • checking

  • setting

  • replicating

  • syncing

Response

None

Example Request

This example updates the replication status to WAITING and the migration stage to cutovered for the dcdbe339-b02d-4578-95a1-9c9c547dxxxx source server.

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

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

Example Response

None

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.

Parent topic: Source Server Management