Querying Details About a Migration Project

Function

This API is used to query details about a migration project with a specified ID.

Calling Method

For details, see Calling APIs.

URI

GET /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. 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

**Table 3** Response body parameters
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
description	String	The migration project description. Minimum length: 0 characters Maximum length: 255 characters
isdefault	Boolean	Indicates whether the migration project is the default project. Default value: false
template	TemplateResponseBody object	The template information.
region	String	The region name. Minimum length: 0 characters Maximum length: 255 characters
start_target_server	Boolean	Indicates whether the target server is started after the migration is complete. Default value: true
speed_limit	Integer	The migration rate limit, in Mbit/s. Minimum value: 0 Maximum value: 10000
use_public_ip	Boolean	Indicates whether a public IP address is used for migration. Default value: true
exist_server	Boolean	Specifies whether an existing server is as the target server. Default value: true
type	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	String	The enterprise project name. Default value: default Minimum length: 0 characters Maximum length: 255 characters
syncing	Boolean	Indicates whether continuous synchronization is performed after the first replication or synchronization is complete. Default value: false
start_network_check	Boolean	Indicates whether network performance measurement is enabled.

**Table 4** **TemplateResponseBody** field description
Parameter	Type	Description
id	String	The template ID. Minimum length: 0 characters Maximum length: 255 characters
name	String	The template name. Minimum length: 0 characters Maximum length: 255 characters
is_template	String	Specifies whether the template is general. If the template is associated with a task, the template is not a general template. Minimum length: 0 characters Maximum length: 255 characters
region	String	The region. Minimum length: 0 characters Maximum length: 255 characters
projectid	String	The project ID. Minimum length: 0 characters Maximum length: 255 characters
target_server_name	String	The target server name. Minimum length: 0 characters Maximum length: 255 characters
availability_zone	String	The AZ. Minimum length: 0 characters Maximum length: 255 characters
volumetype	String	The data disk type. SAS: serial attached SCSI SSD: solid-state drive SATA: serial advanced technology attachment The value can be: SAS SSD SATA
flavor	String	The server flavor. Minimum length: 0 characters Maximum length: 255 characters
vpc	VpcObject object	The VPC information.
nics	Array of Nics objects	The NIC information. Multiple NICs are supported. To let the system automatically add a NIC, configure only one NIC entry and set the ID to autoCreate. Array length: 0 to 65,535
security_groups	Array of SgObject objects	The security group information. Multiple security groups are supported. To let the system automatically create a security group, configure only one security group entry and set the ID to autoCreate. Array length: 0 to 65,535
publicip	PublicIp object	The public IP address information.
disk	Array of TemplateDisk objects	The disk information. Array length: 0 to 65,535
data_volume_type	String	The data disk type. SAS: serial attached SCSI SSD: solid-state drive SATA: serial advanced technology attachment The value can be: SAS SSD SATA
target_password	String	The target server password. Minimum length: 0 characters Maximum length: 1,024 characters
image_id	String	The ID of the selected image. Minimum length: 0 characters Maximum length: 255 characters

**Table 5** **VpcObject** field description
Parameter	Type	Description
id	String	The VPC ID. To let the system automatically create a VPC, set this parameter to autoCreate. Minimum length: 1 character Maximum length: 255 characters
name	String	The VPC name. Minimum length: 1 character Maximum length: 255 characters
cidr	String	The VPC CIDR block. The default value is 192.168.0.0/16. Minimum length: 1 character Maximum length: 255 characters

**Table 6** **Nics** field description
Parameter	Type	Description
id	String	The subnet ID. To let the system automatically create a subnet, set this parameter to autoCreate. Minimum length: 0 characters Maximum length: 255 characters
name	String	The subnet name. Minimum length: 0 characters Maximum length: 255 characters
cidr	String	The subnet gateway/mask. Minimum length: 0 characters Maximum length: 255 characters
ip	String	The server IP address. If this parameter is not specified, the system will automatically assign an IP address. Minimum length: 0 characters Maximum length: 255 characters

**Table 7** **SgObject** field description
Parameter	Type	Description
id	String	The security group ID. Minimum length: 0 characters Maximum length: 255 characters
name	String	The security group name. Minimum length: 0 characters Maximum length: 255 characters

**Table 8** **PublicIp** field description
Parameter	Type	Description
type	String	The EIP type. The default value is 5_bgp. Minimum length: 0 characters Maximum length: 255 characters
bandwidth_size	Integer	The bandwidth size in Mbit/s. The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 to 300 Mbit/s. The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1,000 Mbit/s. The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1,000 Mbit/s. Minimum value: 1 Maximum value: 2000
bandwidth_share_type	String	The bandwidth type, shared or dedicated. Minimum length: 0 characters Maximum length: 255 characters

**Table 9** **TemplateDisk** field description
Parameter	Type	Description
id	Long	The disk ID. Minimum value: 0 Maximum value: 9223372036854775807
index	Integer	The disk index, starting from 0. Minimum value: 0 Maximum value: 2147483647
name	String	The disk name. Minimum length: 0 characters Maximum length: 255 characters
disktype	String	The disk type. The value is the same as that of volumetype. Minimum length: 0 characters Maximum length: 255 characters
size	Long	The disk size in GB. Minimum value: 0 Maximum value: 9223372036854775807
device_use	String	The disk usage. Minimum length: 0 characters Maximum length: 255 characters

Example Request

This example queries the migration project whose ID is 137224b7-8d7c-4919-b33e-ed159778d7a7.

GET  https://{endpoint}/v3/migprojects/137224b7-8d7c-4919-b33e-ed159778d7a7

Example Response

Status code: 200

{
  "id" : "137224b7-8d7c-4919-b33e-ed159778d7a7",
  "name" : "456",
  "template" : {
    "id" : "6c6b6a50-6a6a-4d22-bd2c-78455ee5f6df",
    "name" : "123456",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "06334e957c80d2642f39c0030856abdb",
    "flavor" : "Si1.large.4",
    "volumetype" : "",
    "vpc" : {
      "id" : "b28f58da-9c30-4fc1-86a1-eef49056cab6",
      "name" : "vpc-b162zzzz(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "3b9d5436-80cf-42a3-8f1a-61f125042eb8",
      "name" : "subnet-b18ezzz(192.168.0.0/24)",
      "cidr" : "192.168.0.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "6ea2b372-772d-41ee-84a8-cb309480807d",
      "name" : "default(Inbound:tcp/3389,22; Outbound:--)"
    } ]
  },
  "isdefault" : true,
  "region" : null,
  "start_target_server" : false,
  "speed_limit" : 0,
  "use_public_ip" : true
}