Querying the Change Progress of a Specified Instance in a Background Task
Function
This API is used to query the change progress of a specified instance in a background task.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress
| 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 The progress can be queried only during Kafka capacity expansion. Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| progress_percentage | Integer | Definition Progress. Range N/A |
| remain_time | Integer | Definition Remaining time. Range N/A |
| step_list | Array of StepDetail objects | Definition Step list. |
Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress Example Responses
Status code: 200
Change progress of the instance in the background task queried.
{
"progress_percentage" : 100,
"remain_time" : 0,
"step_list" : [ {
"name" : "pre_check",
"statue" : "COMPLETED",
"start_time" : 1763350067752,
"end_time" : 1763350111208
}, {
"name" : "disk_expansion",
"statue" : "COMPLETED",
"start_time" : 1763350111326,
"end_time" : 1763350189383
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Change progress of the instance in the background task queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
