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. 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
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 |
Indicates whether the migration project is the default project. Default value: false |
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 to use an existing ECS 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: |
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. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
The error code. Minimum length: 0 characters Maximum length: 255 characters |
error_msg |
String |
The error message. Minimum length: 0 characters Maximum length: 255 characters |
encoded_authorization_message |
String |
Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters |
error_param |
Array of strings |
Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20 |
details |
Array of details objects |
The error message. Array length: 1 to 20 |
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
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
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot