Updated on 2022-08-05 GMT+08:00

Updating the Migration Task Status of a Source Server

Function

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

URI

PUT /v3/sources/{source_id}/changestate

Table 1 Path parameter

Parameter

Mandatory

Type

Description

source_id

Yes

String

Specifies 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

Specifies 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

Specifies the migration task status of the source server.

The value can be:

  • UNAVAILABLE
  • WAITING
  • INIT
  • REPLICATE
  • SYNCING
  • STOPPING
  • STOPPED
  • DELETING
  • ERROR
  • CLONING
  • CUTOVERING

migrationcycle

No

String

Specifies the current migration stage of the source server.

The value can be:

  • cutovering
  • cutovered
  • checking
  • setting
  • replicating
  • syncing

Response

None

Example Request

Change the migration status of the source server with ID dcdbe339-b02d-4578-95a1-9c9c547dxxxx.

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

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.