Updated on 2024-09-26 GMT+08:00

Modifying a Migration Project

Function

This API is used to modify a migration project.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/migprojects/{mig_project_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

mig_project_id

Yes

String

The migration project ID.

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. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

No

String

The migration project ID.

Minimum length: 1 character

Maximum length: 254 characters

name

Yes

String

The migration project name.

Minimum length: 2 characters

Maximum length: 19 characters

description

No

String

Describes the migration project.

Minimum length: 0 characters

Maximum length: 255 characters

isdefault

No

Boolean

Whether the migration project is the default project.

Default value: false

region

Yes

String

The region name.

Minimum length: 0 characters

Maximum length: 255 characters

start_target_server

No

Boolean

Specifies whether to start the target server after the migration.

Default value: true

speed_limit

No

Integer

The migration rate limit, in Mbit/s.

Minimum value: 0

Maximum value: 10000

use_public_ip

Yes

Boolean

Specifies whether to use a public IP address for migration.

Default value: true

exist_server

Yes

Boolean

Specifies whether to use an existing ECS as the target server.

Default value: true

type

Yes

String

The migration project type.

The value can be:

  • MIGRATE_BLOCK

  • MIGRATE_FILE

enterprise_project

No

String

The enterprise project name.

Default value: default

Minimum length: 0 characters

Maximum length: 255 characters

syncing

Yes

Boolean

Specifies whether to perform a continuous synchronization after the first replication or synchronization.

Default value: false

start_network_check

No

Boolean

Whether to measure the network performance.

Response

None

Example Request

This example modifies the information about the migration project whose ID is 9879f7aa-3347-47fb-8f89-6070f9e0xxxx. The new migration project name is 225, the region information is region, the speed limit is 100 Mbit/s, and the migration type is MIGRATE_FILE.

PUT  https://{endpoint}/v3/migprojects/9879f7aa-3347-47fb-8f89-6070f9e0xxxx

{
  "name" : 225,
  "region" : "region",
  "description" : "hello",
  "start_target_server" : true,
  "speed_limit" : 100,
  "use_public_ip" : true,
  "exist_server" : true,
  "type" : "MIGRATE_FILE",
  "syncing" : false
}

Example Response

None

SDK Sample Code

The sample code is as follows.

This example modifies the migration project with ID 9879f7aa-3347-47fb-8f89-6070f9e0xxxx. The new migration project name is 225, the region information is region, the speed limit is 100 Mbit/s, and the migration type is MIGRATE_FILE.

 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
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 UpdateMigprojectSolution {

    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();
        UpdateMigprojectRequest request = new UpdateMigprojectRequest();
        MigProject body = new MigProject();
        body.withSyncing(false);
        body.withType(MigProject.TypeEnum.fromValue("MIGRATE_FILE"));
        body.withExistServer(true);
        body.withUsePublicIp(true);
        body.withSpeedLimit(100);
        body.withStartTargetServer(true);
        body.withRegion("region");
        body.withDescription("hello");
        body.withName("225");
        request.withBody(body);
        try {
            UpdateMigprojectResponse response = client.updateMigproject(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 modifies the migration project with ID 9879f7aa-3347-47fb-8f89-6070f9e0xxxx. The new migration project name is 225, the region information is region, the speed limit is 100 Mbit/s, and the migration type is MIGRATE_FILE.

 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
# 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 = UpdateMigprojectRequest()
        request.body = MigProject(
            syncing=False,
            type="MIGRATE_FILE",
            exist_server=True,
            use_public_ip=True,
            speed_limit=100,
            start_target_server=True,
            region="region",
            description="hello",
            name="225"
        )
        response = client.update_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 modifies the migration project with ID 9879f7aa-3347-47fb-8f89-6070f9e0xxxx. The new migration project name is 225, the region information is region, the speed limit is 100 Mbit/s, and the migration type is MIGRATE_FILE.

 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
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.UpdateMigprojectRequest{}
	speedLimitMigProject:= int32(100)
	startTargetServerMigProject:= true
	descriptionMigProject:= "hello"
	request.Body = &model.MigProject{
		Syncing: false,
		Type: model.GetMigProjectTypeEnum().MIGRATE_FILE,
		ExistServer: true,
		UsePublicIp: true,
		SpeedLimit: &speedLimitMigProject,
		StartTargetServer: &startTargetServerMigProject,
		Region: "region",
		Description: &descriptionMigProject,
		Name: "225",
	}
	response, err := client.UpdateMigproject(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 project has been modified successfully.

Error Codes

For details, see Error Codes.