Listing Migration Projects
Function
SMS enables you to use migration projects to manage source servers. This API is used to obtain the list of all migration projects under the current account.
Calling Method
For details, see Calling APIs.
URI
GET /v3/migprojects
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
The number of migration projects recorded on each page Minimum value: 0 Maximum value: 100 Default value: 50 |
offset |
No |
Integer |
The offset. Minimum value: 0 Maximum value: 65535 Default value: 0 |
Request
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 |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
The number of queried migration projects. Minimum value: 0 Maximum value: 2147483647 |
migprojects |
Array of MigprojectsResponseBody objects |
The details of the queried migration projects. Array length: 0 to 65,535 characters |
Parameter |
Type |
Description |
---|---|---|
id |
String |
The migration project ID. Minimum length: 1 character Maximum length: 254 characters |
name |
String |
The migration project name. Minimum length: 2 characters Maximum length: 19 characters |
use_public_ip |
Boolean |
Specifies whether to use a public IP address for migration. |
isdefault |
Boolean |
Specifies whether the migration project is the default project. |
start_target_server |
Boolean |
Specifies whether to start the target server after the migration. |
region |
String |
The region name. Minimum length: 0 characters Maximum length: 255 characters |
speed_limit |
Integer |
The migration rate limit configured in the project. The unit is Mbit/s. Minimum value: 0 Maximum value: 10000 |
exist_server |
Boolean |
Specifies whether there are servers in the migration project. |
description |
String |
Describes the migration project. Minimum length: 0 characters Maximum length: 255 characters |
type |
String |
The default migration type of the project. The value can be: |
enterprise_project |
String |
The name of the enterprise project to which the migration project belongs. Minimum length: 0 characters Maximum length: 255 characters |
syncing |
Boolean |
Whether to perform a continuous synchronization after the full replication is complete. |
start_network_check |
Boolean |
Whether to measure the network performance. |
Example Request
Obtain the list of migration projects.
GET https://{endpoint}/v3/migprojects
Example Response
Status code: 200
A list of migration projects is obtained successfully.
{ "count" : 6, "migprojects" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms_test", "use_public_ip" : true, "isdefault" : true, "start_target_server" : true, "region" : "06334e957c80d2642f39c0030856abdb", "speed_limit" : 0, "exist_server" : true, "description" : "", "type" : "MIGRATE_BLOCK", "enterprise_project" : "defalut" }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "SystemProject", "use_public_ip" : true, "isdefault" : false, "start_target_server" : true, "region" : "region", "speed_limit" : 0, "exist_server" : true, "description" : "", "type" : "MIGRATE_BLOCK", "enterprise_project" : "defalut" }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms_test", "use_public_ip" : true, "isdefault" : false, "start_target_server" : true, "region" : "region", "speed_limit" : 0, "exist_server" : true, "description" : "", "type" : "MIGRATE_BLOCK", "enterprise_project" : "defalut" }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms_test_Test", "use_public_ip" : true, "isdefault" : false, "start_target_server" : true, "region" : "region", "speed_limit" : 0, "exist_server" : true, "description" : "", "type" : "MIGRATE_BLOCK", "enterprise_project" : "defalut" }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms_test002", "use_public_ip" : true, "isdefault" : false, "start_target_server" : true, "region" : "region", "speed_limit" : 0, "exist_server" : true, "description" : "", "type" : "MIGRATE_BLOCK", "enterprise_project" : "defalut" }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms_test003", "use_public_ip" : true, "isdefault" : false, "start_target_server" : true, "region" : "region", "speed_limit" : 0, "exist_server" : true, "description" : "", "type" : "MIGRATE_BLOCK", "enterprise_project" : "defalut" } ] }
SDK Sample Code
The sample code is as follows.
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 |
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 ListMigprojectsSolution { 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(); ListMigprojectsRequest request = new ListMigprojectsRequest(); request.withLimit(<limit>); request.withOffset(<offset>); try { ListMigprojectsResponse response = client.listMigprojects(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()); } } } |
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 |
# 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 = ListMigprojectsRequest() request.limit = <limit> request.offset = <offset> response = client.list_migprojects(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.ListMigprojectsRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListMigprojects(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 |
A list of migration projects is obtained successfully. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot