Help Center/ Server Migration Service/ API Reference/ APIs V3.0/ Source Server Management/ Updating the Migration Task Status of a Source Server
Updated on 2025-06-19 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.

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 of the source server 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.

SKIPPING: The operation is being skipped.

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.

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.

premiging: The migration drill is in progress.

premiged: The migration drill has been completed.

premigfailed: The migration drill fails.

The value can be:

  • UNAVAILABLE

  • WAITING

  • INIT

  • REPLICATE

  • SYNCING

  • STOPPING

  • STOPPED

  • SKIPPING

  • DELETING

  • ERROR

  • CLONING

  • CUTOVERING

  • FINISHED

  • clearing

  • cleared

  • clearfailed

  • premigready

  • premiging

  • premiged

  • premigfailed

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

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

SDK Sample Code

The sample code is as follows.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;


public class UpdateCopyStateSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateCopyStateRequest request = new UpdateCopyStateRequest();
        request.withSourceId("{source_id}");
        PutCopyStateReq body = new PutCopyStateReq();
        body.withMigrationcycle(PutCopyStateReq.MigrationcycleEnum.fromValue("cutovered"));
        body.withCopystate(PutCopyStateReq.CopystateEnum.fromValue("WAITING"));
        request.withBody(body);
        try {
            UpdateCopyStateResponse response = client.updateCopyState(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = SmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateCopyStateRequest()
        request.source_id = "{source_id}"
        request.body = PutCopyStateReq(
            migrationcycle="cutovered",
            copystate="WAITING"
        )
        response = client.update_copy_state(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateCopyStateRequest{}
	request.SourceId = "{source_id}"
	migrationcyclePutCopyStateReq:= model.GetPutCopyStateReqMigrationcycleEnum().CUTOVERED
	copystatePutCopyStateReq:= model.GetPutCopyStateReqCopystateEnum().WAITING
	request.Body = &model.PutCopyStateReq{
		Migrationcycle: &migrationcyclePutCopyStateReq,
		Copystate: &copystatePutCopyStateReq,
	}
	response, err := client.UpdateCopyState(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

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.