查询任务列表 - QueryingTasks
接口约束
最多查询最近一个月的任务列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/tasks
名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
status | 否 | String | 参数解释: 任务状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
name | 否 | String | 参数解释: 任务名称。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
start_time | 否 | String | 参数解释: 开始时间。UNIX时间戳格式,单位是毫秒,时区是UTC。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_time | 否 | String | 参数解释: 结束时间。UNIX时间戳格式,单位是毫秒,时区是UTC。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
offset | 否 | Integer | 参数解释: 索引位置,偏移量。 约束限制: 不涉及。 取值范围: 0 ~ 2,147,483,647。 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
limit | 否 | Integer | 参数解释: 查询记录数。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 默认为100。 |
请求参数
无。
响应参数
名称 | 参数类型 | 说明 |
|---|---|---|
tasks | Array of objects | 参数解释: 任务列表。 详情请参见表3 tasks字段数据结构说明。 |
total_count | Integer | 参数解释: 任务数量。 取值范围: 不涉及。 |
名称 | 参数类型 | 说明 |
|---|---|---|
instance_info | Object | 参数解释: 任务绑定的实例信息。 详情请参见表4 instance_info字段数据结构说明。 |
job_id | String | 参数解释: 任务ID。 取值范围: 不涉及。 |
name | String | 参数解释: 任务名称。 取值范围: 不涉及。 |
status | String | 参数解释: 任务状态。 取值范围:
|
process | String | 参数解释: 任务进度,单位:%。 取值范围: 不涉及。 |
created_at | String | 参数解释: 创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 |
ended_at | String | 参数解释: 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 |
fail_reason | String | 参数解释: 失败原因。 取值范围: 不涉及。 |
名称 | 参数类型 | 说明 |
|---|---|---|
instance_id | String | 参数解释: 实例ID。 取值范围: 不涉及。 |
instance_name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
instance_status | String | 参数解释: 实例状态。 取值范围:
|
请求示例
- 查询任务状态为“运行中”的任务列表
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 - 查询任务状态为“完成”的任务列表
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&name=CreateGaussDBV5Instance&offset=1&limit=10 - 查询任务状态为“失败”的任务列表
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&name=CreateGaussDBV5Instance&offset=1&limit=10
响应示例
查询任务列表成功。
{
"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
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。

