查询引擎任务列表 - QueryEngineJobList
功能介绍
查询引擎任务列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cse:engine:get
read
engine
-
-
URI
GET /v2/{project_id}/enginemgr/engines/{engine_id}/jobs
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户子项目的唯一标识。字符长度为1~64。 |
engine_id | 是 | String | 微服务引擎ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | String | 分页的页码。 |
limit | 否 | String | 每页显示的条目数量。 |
from-time | 否 | String | 查询日期范围的起始时间。 |
to-time | 否 | String | 查询日期范围的结束时间。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。 |
X-Enterprise-Project-ID | 否 | String | 如果不带则默认企业项目为“default”，ID为“0”。 |
Content-Type | 是 | String | 该字段内容填为 "application/json;charset=UTF-8"。 |
Accept | 是 | String | 该字段内容填为 "application/json"。 |
响应参数
参数 | 参数类型 | 描述 |
|---|---|---|
total | Integer | 引擎任务总数。 |
data | Array of Job objects | 任务列表。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | Integer | 任务ID。 |
engineId | String | 任务所属引擎ID。 |
type | String | 任务类型。 取值范围：
|
description | String | 任务描述。 |
status | String | 任务状态。 取值范围：
|
scheduling | Integer | 任务是否正在执行。 取值范围：
|
createUser | String | 任务创建者。 |
startTime | Long | 任务开始时间。 |
endTime | Long | 任务结束时间。 |
context | String | 任务执行上下文。 |
tasks | Array of Task objects | 任务包含的处理阶段。 |
参数 | 参数类型 | 描述 |
|---|---|---|
jobId | Integer | 子任务所属任务ID。 |
id | Long | 子任务ID，使用uuid。 |
type | String | 子任务的类型。 取值范围：
|
assigned | String | 子任务的执行者。 |
taskName | String | 子任务名称。 |
engineName | String | 子任务所属引擎名称。 |
taskOrder | Integer | 子任务执行的顺序，从小到大。 |
status | String | 子任务状态。 取值范围：
|
startTime | Long | 子任务开始时间。 |
endTime | Long | 子任务结束时间。 |
createTime | Long | 子任务创建时间。 |
updateTime | Long | 子任务更新时间。 |
timeout | Integer | 子任务是否超时。 |
log | String | 子任务详细信息，执行过程中产生的辅助信息。 |
output | String | 子任务输出信息。 |
taskExecutorBrief | TaskExecutorBrief object | 任务元数据。 |
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误信息。 |
detail | String | 详细定位信息。 |
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误信息。 |
detail | String | 详细定位信息。 |
请求示例
GET https://{endpoint}/v2/{project_id}/enginemgr/engines/{engine_id}/jobs 响应示例
状态码： 200
success
{
"total": 100,
"data": [
{
"id": 12339,
"engineId": "ad76972c-a743-4770-859c-c98a680f4d98",
"type": "Create",
"description": "",
"status": "Finished",
"scheduling": 0,
"createUser": "test",
"startTime": 1636540095901,
"endTime": 1636540460230,
"context": "string",
"tasks": [
{
"jobId": 12339,
"id": 89117,
"type": "Create",
"assigned": "string",
"taskName": "TenantTaskExecutor",
"engineName": "test",
"taskOrder": 0,
"status": "Init",
"startTime": 1636540100216,
"endTime": 1636540110215,
"createTime": 1636540095910,
"updateTime": 1636540110230,
"timeout": -1,
"log": "string",
"output": "{}",
"taskExecutorBrief": {
"duration": 6000,
"description": "租户处理"
}
}
]
}
]
} 状态码
状态码 | 描述 |
|---|---|
200 | success |
400 | 错误的请求。 |
500 | 服务器内部错误。 |
错误码
请参见CSE错误码。
