Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ APIs V3.0/ Migration Project Management/ Querying Details About a Migration Project with a Specified ID
Updated on 2022-08-02 GMT+08:00

Querying Details About a Migration Project with a Specified ID

Function

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

URI

GET /v3/migprojects/{mig_project_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

mig_project_id

Yes

String

Specifies 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

Specifies 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

name

String

Specifies the migration project name.

Minimum length: 0 characters

Maximum length: 255 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

region

String

Specifies the region where the project resides.

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

Specifies 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

Specifies the migration project type.

The value can be:

  • MIGRATE_BLOCK
  • MIGRATE_FILE

enterprise_project

String

Specifies 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

Example Request

Query 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

OK

Error Codes

See Error Codes.