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 is being initialized. REPLICATE: The source server is being replicated. SYNCING: The source server is being synchronized. SYNCING: 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 FINISHED
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

**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	Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error message. Array length: 1 to 20

**Table 6** **details** field description
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 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

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."
  } ]
}