Querying a Background Task
Function
This API is used to query a specified background task.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
| instance_id | Yes | String | Instance ID. |
| task_id | Yes | String | Task ID. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| task_count | String | Definition Number of tasks. Range N/A |
| tasks | Array of tasks objects | Definition Task list. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Task ID. Range N/A |
| name | String | Definition Task name. Range N/A |
| user_name | String | Definition Username. Range N/A |
| user_id | String | Definition User ID. Range N/A |
| params | String | Definition Task parameters. Range N/A |
| status | String | Definition Task status. Range |
| created_at | String | Definition Start time. Range N/A |
| updated_at | String | Definition End time. Range N/A |
Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id} Example Responses
Status code: 200
The query is successful.
{
"task_count" : "1",
"tasks" : [ {
"id" : "8abfa7b272adc5b40172b73130065ae7",
"name" : "bindInstancePublicIp",
"user_name" : "paas_dms",
"user_id" : "3df5acbc24a54fadb62a043c9000a307",
"params" : "{\"public_ip_id\":\"1aea7aed-e7d8-40ea-b3de-6f3ee9d5db9f\",\"public_ip_address\":\"100.93.2.18\",\"enable_public_ip\":true}",
"status" : "SUCCESS",
"created_at" : "2020-06-15T08:55:53.606Z",
"updated_at" : "2020-06-15T08:55:56.600Z"
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The query is successful. |
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.
