Reporting Migration Progress and Rate

Function

This API is called by the Agent installed on source servers during migration to report the migration progress and speed to SMS.

You do not need to make calls to this API.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/tasks/{task_id}/progress

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The migration task 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
subtask_name	Yes	String	The name of the subtask whose progress is being reported. Options: CREATE_CLOUD_SERVER SSL_CONFIG ATTACH_AGENT_IMAGE DETTACH_AGENT_IMAGE FORMAT_DISK_LINUX FORMAT_DISK_LINUX_FILE FORMAT_DISK_LINUX_BLOCK FORMAT_DISK_WINDOWS MIGRATE_LINUX_FILE MIGRATE_LINUX_BLOCK MIGRATE_WINDOWS_BLOCK CLONE_VM SYNC_LINUX_FILE SYNC_LINUX_BLOCK SYNC_WINDOWS_BLOCK CONFIGURE_LINUX CONFIGURE_LINUX_BLOCK CONFIGURE_LINUX_FILE CONFIGURE_WINDOWS Minimum: 0 Maximum: 255 Enumeration values: CREATE_CLOUD_SERVER SSL_CONFIG ATTACH_AGENT_IMAGE DETTACH_AGENT_IMAGE FORMAT_DISK_LINUX FORMAT_DISK_LINUX_FILE FORMAT_DISK_LINUX_BLOCK FORMAT_DISK_WINDOWS MIGRATE_LINUX_FILE MIGRATE_LINUX_BLOCK MIGRATE_WINDOWS_BLOCK CLONE_VM SYNC_LINUX_FILE SYNC_LINUX_BLOCK SYNC_WINDOWS_BLOCK CONFIGURE_LINUX CONFIGURE_LINUX_BLOCK CONFIGURE_LINUX_FILE CONFIGURE_WINDOWS
progress	Yes	Integer	The progress of the subtask, in percentage. Minimum: 0 Maximum: 100
replicatesize	Yes	Long	The amount of data replicated in the subtask, in bytes. Minimum: 0 Maximum: 9223372036854775807
totalsize	Yes	Long	The total amount of data to be migrated in the subtask. Minimum: 0 Maximum: 9223372036854775807
process_trace	Yes	String	The detailed progress of the migration or synchronization. Minimum: 0 Maximum: 2048
migrate_speed	No	Double	The migration rate, in Mbit/s. Minimum: 0 Maximum: 10000
compress_rate	No	Double	The file compression rate. Minimum: 0 Maximum: 10000
remain_time	No	Long	The remaining time. Minimum: 0 Maximum: 2147483647
total_cpu_usage	No	Double	The CPU usage of the server. The value ranges from 0 to 100, in percentage. Minimum: 0 Maximum: 100
agent_cpu_usage	No	Double	The CPU usage of the Agent. The value ranges from 0 to 100, in percentage. Minimum: 0 Maximum: 100
total_mem_usage	No	Double	The memory usage of the server, in MB. Minimum: 0 Maximum: 1048576.0
agent_mem_usage	No	Double	The memory usage of the Agent, in MB. Minimum: 0 Maximum: 1048576.0
total_disk_io	No	Double	The disk I/O of the server, in Mbit/s. Minimum: 0 Maximum: 10000.0
agent_disk_io	No	Double	The disk I/O of the Agent, in Mbit/s. Minimum: 0 Maximum: 10000.0
need_migration_test	No	Boolean	Indicates whether migration drilling is enabled.
agent_time	No	String	The current local time of the source server, which is used for overspeed detection. The speed limits can be configured by time period. Minimum: 0 Maximum: 30

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	String	The migration progress and speed were reported.

Status code: 403

**Table 5** 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 6** 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 reports the migration progress of a task. The current subtask name is ATTACH_AGENT_IMAGE, the task progress is 100, and the total size of data migrated in the current task is 10000.

PUT https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/progress

{
  "subtask_name" : "ATTACH_AGENT_IMAGE",
  "progress" : 100,
  "replicatesize" : 1000,
  "totalsize" : 100000,
  "process_trace" : ""
}

Example Responses

Status code: 200

The migration progress and speed were reported.

{ }

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."
  } ]
}