Help Center/Server Migration Service/API Reference/API/Migration Project Management/Querying Details About a Migration Project with a Specified ID
Updated on 2026-01-27 GMT+08:00
View PDF

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.

Calling Method

For details, see Calling APIs.

URI

GET /v3/migprojects/{mig_project_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

mig_project_id

Yes

String

The migration project ID.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Migration project name. The value can contain only letters, digits, underscores (_), and hyphens (-).

Minimum: 1

Maximum: 100

description

String

The migration project description.

Minimum: 0

Maximum: 255

isdefault

Boolean

Indicates whether the migration project is the default project.

Default: false

region

String

The region name.

Minimum: 0

Maximum: 255

start_target_server

Boolean

Indicates whether the target server is started after the migration is complete.

Default: true

speed_limit

Integer

The migration rate limit, in Mbit/s.

Minimum: 0

Maximum: 1000

use_public_ip

Boolean

Indicates whether a public IP address is used for migration.

Default: true

exist_server

Boolean

Specifies whether an existing server is as the target server.

Default: true

type

String

The migration project type.

MIGRATE_BLOCK

MIGRATE_FILE

Enumeration values:

  • MIGRATE_BLOCK

  • MIGRATE_FILE

enterprise_project

String

The enterprise project name.

Default: default

Minimum: 0

Maximum: 255

syncing

Boolean

Indicates whether continuous synchronization is performed after the first replication or synchronization is complete.

Default: false

start_network_check

Boolean

Indicates whether network performance measurement is enabled.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 255

encoded_authorization_message

String

The encrypted authorization information.

Minimum: 0

Maximum: 65535

error_param

Array of strings

Error parameters.

Minimum: 0

Maximum: 65535

Array Length: 1 - 20

details

Array of details objects

The error details.

Array Length: 1 - 20

Table 5 details

Parameter

Type

Description

error_code

String

The SMS error code.

Minimum: 0

Maximum: 65535

error_msg

String

The SMS error message.

Minimum: 0

Maximum: 65535

Example Requests

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 Responses

Status code: 200

The details about the migration project with a specified ID were queried.

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
  "name" : "456",
  "isdefault" : true,
  "region" : null,
  "start_target_server" : false,
  "speed_limit" : 0,
  "use_public_ip" : true
}

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}

Status Codes

Status Code

Description

200

The details about the migration project with a specified ID were queried.

403

Authentication failed.

Error Codes

See Error Codes.