Querying Progress of an Instance Change Record

Function

Querying Progress of a Specified Instance Change Record in Background Task Management

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A
task_id	Yes	String	Definition Task ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
progress_percentage	Integer	Definition Background task processing progress. Range N/A
remain_time	Integer	Definition Remaining time. Range N/A
step_list	Array of StepDetail objects	Definition Step list.

**Table 3** StepDetail
Parameter	Type	Description
name	String	Definition Task name. Range N/A
status	String	Definition Task status. Range COMPLETED IN_PROGRESS FAILED WAITING
start_time	String	Definition Start time. Range N/A
end_time	String	Definition End time. Range N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress

Example Responses

Status code: 200

Scheduled task modified.

{
  "progress_percentage" : 40,
  "remain_time" : 1124,
  "step_list" : [ {
    "name" : "pre_check",
    "statue" : "COMPLETED",
    "start_time" : 1765307538503,
    "end_time" : 1765307543133
  }, {
    "name" : "rolling_scaling",
    "statue" : "IN_PROGRESS",
    "start_time" : 1765307543286,
    "end_time" : null
  }, {
    "name" : "resume_operation",
    "statue" : "WAITING",
    "start_time" : null,
    "end_time" : null
  } ]
}