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

**Table 1** Query parameters
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

**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

Response

Status code: 200

**Table 3** Response body parameters
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

**Table 4** **MigprojectsResponseBody** field description
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: MIGRATE_BLOCK MIGRATE_FILE
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"
  } ]
}