On this page

Function
Calling Method
URI
Request
Response
Example Request
Example Response
Status Codes
Error Codes

Show all

Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ APIs V3.0/ Source Server Management/ Updating the Migration Task Status of a Source Server

Updating the Migration Task Status of a Source Server

Updated on 2025-02-13 GMT+08:00

View PDF

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

Status Codes

Status Code	Description
200	The migration task status of a source server was updated.
403	Authentication failed.

Error Codes

For details, see Error Codes.

Parent topic: Source Server Management

Previous topic: Modifying Source Server Information

Next topic: Deleting a Source Server Record

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot