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}
Parameter | Mandatory | Type | Description |
---|---|---|---|
mig_project_id | Yes | String | The migration project ID. Minimum length: 0 characters Maximum length: 255 characters |
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 |
---|---|---|
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 |
description | String | Describes the migration project. Minimum length: 0 characters Maximum length: 255 characters |
isdefault | Boolean | Specifies 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 | Specifies whether to start the target server after the migration. Default value: true |
speed_limit | Integer | The migration rate limit, in Mbit/s. Minimum value: 0 Maximum value: 10000 |
use_public_ip | Boolean | Specifies whether to use a public IP address for migration. Default value: true |
exist_server | Boolean | Specifies whether to use an existing ECS as the target server. Default value: true |
type | String | The migration project type. The value can be:
|
enterprise_project | String | The enterprise project name. Default value: default Minimum length: 0 characters Maximum length: 255 characters |
syncing | Boolean | Specifies whether to perform a continuous synchronization after the first replication or synchronization. Default value: false |
start_network_check | Boolean | Whether to measure the network performance. |
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 name of the target server. Minimum length: 0 characters Maximum length: 255 characters |
availability_zone | String | The AZ. Minimum length: 0 characters Maximum length: 255 characters |
volumetype | String | The disk type. The value can be:
|
flavor | String | The flavor of the target server. 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. If the target server is automatically created, enter only one NIC and set the ID to autoCreate. Array length: 0 to 65,535 characters |
security_groups | Array of SgObject objects | The security group information. Multiple security groups are supported. If the target server is automatically created, enter only one security group and set the ID to autoCreate. Array length: 0 to 65,535 characters |
publicip | PublicIp object | The public IP address. |
disk | Array of TemplateDisk objects | The disk information. Array length: 0 to 65,535 characters |
data_volume_type | String | The disk type. The value can be:
|
target_password | String | The password for logging in to the target server. 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 |
Parameter | Type | Description |
---|---|---|
id | String | The VPC ID. If the target server is created automatically, 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 |
Parameter | Type | Description |
---|---|---|
id | String | The subnet ID. If the target server is created automatically, 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 IP address of the target server. If this parameter is not specified, the system will automatically assign an IP address. Minimum length: 0 characters Maximum length: 255 characters |
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 |
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 |
Parameter | Type | Description |
---|---|---|
id | Long | The disk ID. Minimum value: 0 Maximum value: 9223372036854775807 |
index | Integer | The disk serial number, 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 used disk space. 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
OK
{"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}
Status Codes
Status Code | Description |
---|---|
200 | Response returned. |
Error Codes
For details, see Error Codes.
- Function
- Calling Method
- URI
- Request
- Response
- Example Request
- Example Response
- Status Codes
- Error Codes