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 rate to SMS.

You do not need to make calls to this API.

URI

PUT /v3/tasks/{task_id}/progress

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
task_id	Yes	String	Specifies the migration task ID for which you set migration rate limit. 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
subtask_name	Yes	String	Specifies the name of the subtask for which the Agent reports the progress. Minimum length: 0 characters Maximum length: 255 characters The value can be: 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	Specifies the progress of the subtask, in percentage (%). Minimum value: 0 Maximum value: 100
replicatesize	Yes	Long	Specifies the amount of data that has been replicated in the subtask, in bytes. Minimum value: 0 Maximum value: 9223372036854775807
totalsize	Yes	Long	Specifies the total amount of data to be migrated in the subtask. Minimum value: 0 Maximum value: 9223372036854775807
process_trace	Yes	String	Detailed progress of the migration or synchronization Minimum length: 0 characters Maximum length: 2048 characters
migrate_speed	No	Double	Specifies the migration rate in Mbit/s. Minimum value: 0 Maximum vale: 10000
compress_rate	No	Double	File compression rate

Response

None

Example Request

Report the progress of the task whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

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