Updating the Migration Status of a Source Server

Function

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

The request parameters are not verified and the update does not take effect if the source server is in the unavailable, stopping, stopped, deleting, finished, clearing, or clearfailed state.

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: 1 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
copystate	Yes	String	Status of the source server. unavailable: The environment verification fails. waiting init: Initializing. replicate: Replicating. syncing stopping stopped skipping deleting clearing: Clearing snapshot resources. cleared: Snapshot resources cleared. clearfailed: Failed to clear snapshot resources. premigready: Ready for migration drill. premiging: Performing migration drill. premiged: Migration drill completed. premigfailed: Migration drill failed. cloning cutovering: Starting the target server. finished: Target server started. error Enumeration values: unavailable waiting init replicate syncing stopping stopped skipping deleting clearing cleared clearfailed premigready premiging premiged premigfailed cloning cutovering finished error
migrationcycle	Yes	String	Migration period. no_ready: not ready. ready_for_test testing tested cutovering: starting the target server. cutovered: target server started. checking setting replicating syncing Enumeration values: no_ready ready_for_test testing tested cutovering cutovered checking setting replicating syncing

Response Parameters

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: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 6** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

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

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

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

Example Responses

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