Updated on 2025-11-11 GMT+08:00

Creating a Migration Project

Function

This API is used to create a migration project.

Constraints

The migration project name must be unique.

Calling Method

For details, see Calling APIs.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    sms:migproject:create

    Write

    migproject *

    -

    • sms:server:migrationServer

    -

URI

POST /v3/migprojects

Request

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

X-Auth-Token

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.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

The migration project name.

description

No

String

The migration project description.

isdefault

No

Boolean

Indicates whether the migration project is the default project.

Default Value

false

region

Yes

String

The region name.

start_target_server

No

Boolean

Indicates whether the target server is started after the migration is complete.

Default Value

true

speed_limit

No

Integer

The migration rate limit, in Mbit/s.

Range

0 to 10000

use_public_ip

Yes

Boolean

Indicates whether a public IP address is used for migration.

Default Value

true

exist_server

Yes

Boolean

Specifies whether an existing server is as the target server.

Default Value

true

type

Yes

String

The migration project type.

MIGRATE_BLOCK: block-level migration

MIGRATE_FILE: file-level migration

The value can be:

  • MIGRATE_BLOCK

  • MIGRATE_FILE

enterprise_project

No

String

The enterprise project name.

Default Value

default

syncing

Yes

Boolean

Indicates whether continuous synchronization is performed after the first replication or synchronization is complete.

Default Value

false

start_network_check

No

Boolean

Indicates whether the network performance is measured.

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

The ID of the new migration project returned after the creation is complete.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

error_msg

String

The error message.

encoded_authorization_message

String

The encrypted authorization information.

error_param

Array of strings

Invalid parameters.

details

Array of details objects

The error details.

Table 5 details field description

Parameter

Type

Description

error_code

String

The SMS error code.

error_msg

String

The SMS error message.

Example Request

This example creates a migration project. The project name is set to N121, the region to region, the public IP address to true, and the migration project type to MIGRATE_BLOCK.

POST https://{endpoint}/v3/migprojects

{
  "name" : "N121",
  "description" : "",
  "region" : "region",
  "start_target_server" : true,
  "speed_limit" : 0,
  "use_public_ip" : true,
  "exist_server" : true,
  "isdefault" : true,
  "type" : "MIGRATE_BLOCK",
  "syncing" : false,
  "enterprise_project" : "default"
}

Example Response

Status code: 200

Creating a migration project succeeded.

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
}

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 creates a migration project. The project name is set to N121, the region to region, the public IP address to true, and the migration project type to MIGRATE_BLOCK.

 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
51
52
53
54
55
56
57
58
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 CreateMigprojectSolution {

    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();
        CreateMigprojectRequest request = new CreateMigprojectRequest();
        PostMigProjectBody body = new PostMigProjectBody();
        body.withSyncing(false);
        body.withEnterpriseProject("default");
        body.withType(PostMigProjectBody.TypeEnum.fromValue("MIGRATE_BLOCK"));
        body.withExistServer(true);
        body.withUsePublicIp(true);
        body.withSpeedLimit(0);
        body.withStartTargetServer(true);
        body.withRegion("region");
        body.withIsdefault(true);
        body.withDescription("");
        body.withName("N121");
        request.withBody(body);
        try {
            CreateMigprojectResponse response = client.createMigproject(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 creates a migration project. The project name is set to N121, the region to region, the public IP address to true, and the migration project type to MIGRATE_BLOCK.

 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
# 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 = CreateMigprojectRequest()
        request.body = PostMigProjectBody(
            syncing=False,
            enterprise_project="default",
            type="MIGRATE_BLOCK",
            exist_server=True,
            use_public_ip=True,
            speed_limit=0,
            start_target_server=True,
            region="region",
            isdefault=True,
            description="",
            name="N121"
        )
        response = client.create_migproject(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 creates a migration project. The project name is set to N121, the region to region, the public IP address to true, and the migration project type to MIGRATE_BLOCK.

 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
51
52
53
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.CreateMigprojectRequest{}
	enterpriseProjectPostMigProjectBody:= "default"
	speedLimitPostMigProjectBody:= int32(0)
	startTargetServerPostMigProjectBody:= true
	isdefaultPostMigProjectBody:= true
	descriptionPostMigProjectBody:= ""
	request.Body = &model.PostMigProjectBody{
		Syncing: false,
		EnterpriseProject: &enterpriseProjectPostMigProjectBody,
		Type: model.GetPostMigProjectBodyTypeEnum().MIGRATE_BLOCK,
		ExistServer: true,
		UsePublicIp: true,
		SpeedLimit: &speedLimitPostMigProjectBody,
		StartTargetServer: &startTargetServerPostMigProjectBody,
		Region: "region",
		Isdefault: &isdefaultPostMigProjectBody,
		Description: &descriptionPostMigProjectBody,
		Name: "N121",
	}
	response, err := client.CreateMigproject(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Status Codes

Status Code

Description

200

Creating a migration project succeeded.

403

Authentication failed.

Error Codes

For details, see Error Codes.