查询内部作业列表-GetSystemJobList
功能介绍
查询内部作业列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataJob:list
List
workspace *
-
-
-
URI
GET /v1.0/{project_id}/data/system-jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| data_id | 否 | String | 参数解释: 输入数据ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| id | 否 | Long | 参数解释: 作业ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| job_types | 否 | Array of strings | 参数解释: 作业类型 约束限制: 最多20个 |
| statuses | 否 | Array of strings | 参数解释: 作业状态 QUEUING:排队中 约束限制: 最多20个 |
| start_time | 否 | Long | 参数解释: 最小创建时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 1000000000000-2000000000000 默认取值: 不涉及 |
| end_time | 否 | Long | 参数解释: 最大更新时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 1000000000000-2000000000000 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空 约束限制: 最小值0 取值范围: 不涉及 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 列表返回的最大记录数 约束限制: 最小为1,最大为200 取值范围: 不涉及 默认取值: 10 |
| sort | 否 | String | 参数解释: 排序 约束限制: 不涉及 取值范围: 默认取值: UPDATE_DESC |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | dataSystemJobPayload object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| list | Array of DataSystemJobListVo objects | 参数解释: 内部作业列表 取值范围: 不涉及 |
| page_info | PageInfo object | 参数解释: 分页信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 作业ID 取值范围: 不涉及 |
| job_type | String | 参数解释: 作业类型 取值范围: |
| data_id | String | 参数解释: 数据ID 取值范围: 不涉及 |
| status | String | 参数解释: 作业状态 取值范围: |
| create_at | Long | 参数解释: 创建时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| update_at | Long | 参数解释: 更新时间,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| start_at | Long | 参数解释: 开始运行时间,作业未开始运行不返回该字段,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| end_at | Long | 参数解释: 运行结束时间,作业未结束不返回该字段,UTC标准时间毫秒时间戳 取值范围: 不涉及 |
| msg_code | Integer | 参数解释: 错误码,作业状态正常不返回该字段 取值范围: 不涉及 |
| project_id | String | 参数解释: 项目ID 取值范围: 不涉及 |
| submitting_duration | Long | 参数解释: 提交时长,毫秒单位(作业创建到k8s开始运行的时长) 取值范围: 不涉及 |
| running_duration | Long | 参数解释: 运行时长,作业未开始运行不返回该字段,毫秒单位(k8s运行时长) 取值范围: 不涉及 |
| resource_spec | String | 参数解释: 资源规格 取值范围: 不涉及 |
| msg_error | String | 参数解释: 错误原因,作业状态正常不返回该字段 取值范围: 不涉及 |
| workspace_id | String | 参数解释: 工作空间ID 取值范围: 不涉及 |
请求示例
内部作业列表
GET https://{endpoint}/v1.0/{project_id}/data/system-job?job_types=SCENARIO_AUTO_MINING 响应示例
状态码:200
查询成功
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"list" : [ {
"id" : 1,
"job_type" : "SCENARIO_AUTO_MINING",
"data_id" : "DPK0000001",
"status" : "FINISHED",
"create_at" : 1640966400000,
"update_at" : 1640966400000,
"start_at" : 1640966400000,
"end_at" : 1640966400000,
"submitting_duration" : 1000,
"running_duration" : 1000,
"project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b",
"resource_spec" : "1Core_4GiB"
} ],
"page_info" : {
"offset" : 0,
"limit" : 1,
"total" : 1
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。