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 |
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. 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 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
The migration project ID. Minimum length: 0 characters Maximum length: 255 characters |
name |
String |
The migration project name. Minimum length: 0 characters Maximum length: 255 characters |
use_public_ip |
Boolean |
Indicates whether a public IP address is used for migration. |
isdefault |
Boolean |
Indicates whether the migration project is the default project. |
start_target_server |
Boolean |
Indicates whether the target server is started after the migration is complete. |
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 |
Indicates whether there are servers in the migration project. |
description |
String |
The migration project description. Minimum length: 0 characters Maximum length: 255 characters |
type |
String |
The migration project type. MIGRATE_BLOCK: block-level migration MIGRATE_FILE: file-level migration 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 |
Indicate whether continuous synchronization is performed after the full replication is complete. |
start_network_check |
Boolean |
Indicates whether network performance measurement is enabled. |
Example Request
This example obtains the list of migration projects.
GET https://{endpoint}/v3/migprojects
Example Response
Status code: 200
The list of migration projects was obtained.
{ "count" : 6, "migprojects" : [ { "id" : "58005530-57a4-4589-85dd-69c7ca1bba17", "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" : "f7edd6c0-7faf-4e1a-8c0b-0bb4b53d162a", "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" : "8dd46a53-c7a6-42c4-98fb-9d140a1f3ac4", "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" : "ee35f0bf-6398-494f-a45c-7825e1499840", "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" : "9ed854a4-c294-449c-9169-2c70d611bfc9", "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" : "feba29f4-e9a2-4d22-b4bb-9e89a29600ab", "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" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The list of migration projects was obtained. |
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.