Querying Tasks
Function
This API is used to query the tasks in the task center. Before calling this API:
- Learn how to authenticate this API.
Constraints
The tasks of the last month can be queried at most.
URI
GET https://{Endpoint}/v3/{project_id}/tasks
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None |
| status | No | String | Task status. Value:
|
| name | No | String | Task name.
|
| start_time | No | String | Start time. The value is a UNIX timestamp, in milliseconds. The time zone is UTC. |
| end_time | No | String | End time. The value is a UNIX timestamp, in milliseconds. The time zone is UTC. |
| offset | No | Integer | Index offset. If offset is set to N, the resource query starts from the N+1 data entry. The default value is 0, indicating that the query starts from the first data entry. The value cannot be a negative number. |
| limit | No | Integer | Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. |
Request Parameters
None
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| tasks | Array of objects | Task list. For details, see Table 3. |
| total_count | Integer | Number of tasks. |
| Parameter | Type | Description |
|---|---|---|
| instance_info | Object | Information about the instance associated with the task. For details, see Table 4. |
| job_id | String | Task ID. |
| name | String | Task name. |
| status | String | Task status. |
| process | String | Task progress, in percentage (%) |
| created_at | String | Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800. |
| ended_at | String | End time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800. |
| fail_reason | String | Failure cause. |
Example Request
- Querying running tasks
GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 - Querying completed tasks
GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&name=CreateGaussDBV5Instance&offset=1&limit=10 - Querying failed tasks
GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&name=CreateGaussDBV5Instance&offset=1&limit=10
Example Response
Tasks queried.
{
"tasks" : [ {
"instance_info" : {
"instance_id" : "ce2dce50f365430abe161bab79495a6ein14",
"instance_name" : "gauss-6568-zzh",
"instance_status" : "creating"
},
"job_id" : "03bc055a-135c-4245-8bd8-b0bc6d3350b3",
"name" : "CreateGaussDBV5Instance",
"status" : "Failed",
"process" : "",
"created_at": "2022-08-05T08:15:07+0800",
"ended_at": "2022-08-09T03:06:52+0800",
"fail_reason" : "500000"
}, {
"instance_info" : {
"instance_id" : "20ba433bd7ee40da9cf35064f04f9e4cin14",
"instance_name" : "gauss-7875-lt-m",
"instance_status" : "deleted"
},
"job_id" : "2cc16e0b-75ab-4a28-9453-16517e990bba",
"name" : "DeleteGaussDBV5Instance",
"status" : "Completed",
"process" : "",
"created_at": "2022-08-06T09:15:07+0800",
"ended_at": "2022-08-10T03:06:52+0800",
"fail_reason" : null
} ],
"total_count" : 2
} Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
