Updating the Migration Status of a Source Server

Function

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

Calling Method

For details, see Calling APIs.

URI

PUT /v3/sources/{source_id}/changestate

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
source_id	Yes	String	The ID of the source server in SMS. Minimum length: 1 character Maximum length: 36

Request

**Table 2** Request header parameters
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. initialize: 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. skipping: The operation is being skipped. deleting: being deleted clearing: The snapshot resources are being cleared. cleared: The snapshot resources have been cleared. clearfailed: The snapshot resources fail to be cleared. premigready: The migration drill is ready. premiged: The migration drill has been completed. premigfailed: The migration drill fails. cloning: The paired target server is being cloned. cutovering: The paired target server is being launched. finished: The paired target server is launched. error: An error occurs. The value can be: unavailable waiting initialize replicate syncing stopping stopped skipping deleting clearing cleared clearfailed premigready premiged premigfailed cloning cutovering finished error
migrationcycle	No	String	The current migration stage of the source server. cutovering: The paired target server is being launched. cutovered: The paired target 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

**Table 4** Response body parameters
Parameter	Type	Description
-	String	The migration task status of a source server was updated.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	The encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameters. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error details. Array length: 1 to 20

**Table 6** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

This example updates the migration 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

Status code: 200

The migration task status of a source server was updated.

{ }

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}