查询排队作业列表-QueryJobQueueList
功能介绍
查询排队作业列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataJobQueue:list
List
-
-
-
-
URI
GET /v1.0/{project_id}/data/queuing-jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| job_id | 否 | Long | 参数解释: 作业ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| output_type | 否 | String | 参数解释: 输出类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| job_type | 否 | String | 参数解释: 内部作业类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| data_id | 否 | String | 参数解释: 数据ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| queue_type | 是 | String | 参数解释: 队列类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 列表返回的最大记录数 约束限制: 最小为1,最大为200 取值范围: 不涉及 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 查询偏移量,与limit配合使用。假如设置offset为11,limit为10,即从第12条数据开始查询,一次最多读取10条记录。当offset超过总记录数时,列表返回为空 约束限制: 最小值0 取值范围: 不涉及 默认取值: 0 |
| processor_name | 否 | String | 参数解释: 算子名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| cluster_type | 否 | String | 参数解释: 集群类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| cluster_id | 否 | String | 参数解释: 集群ID,当cluster_type为MODELARTS时,此字段必填 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | DataJobQueuePayload object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| list | Array of jobQueueVo objects | 参数解释: 队列列表 |
| page_info | PageInfo object | 参数解释: 分页信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 队列ID 取值范围: 不涉及 |
| job_id | Long | 参数解释: 作业ID 取值范围: 不涉及 |
| processor_id | Long | 参数解释: 算子ID(内部作业队列不返回) 取值范围: 不涉及 |
| source | String | 参数解释: 来源(内部作业队列不返回) 取值范围: |
| processor_name | String | 参数解释: 算子名称(内部作业队列不返回) 取值范围: 不涉及 |
| job_type | String | 参数解释: 内部作业类型 取值范围: |
| data_id | String | 参数解释: 数据ID 取值范围: 不涉及 |
| output_type | String | 参数解释: 输出类型(内部作业队列不返回) 取值范围: |
| rank_stamp | Long | 参数解释: 排序时间戳 取值范围: 不涉及 |
| project_id | String | 参数解释: 项目ID 取值范围: 不涉及 |
| resource_spec | String | 参数解释: 资源规格 取值范围: 不涉及 |
| priority | Integer | 参数解释: 优先级 取值范围: 不涉及 |
| queue_type | String | 参数解释: 队列类型 取值范围: |
| workspace_id | String | 参数解释: 工作空间ID 取值范围: 不涉及 |
请求示例
响应示例
状态码:200
查询成功
-
{ "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "id" : 1, "job_id" : 1, "job_type" : "SCENARIO_AUTO_MINING", "data_id" : "DPK0000001", "rank_stamp" : 1640966400000, "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "resource_spec" : "1Core_4GiB", "priority" : 0, "queue_type" : "INTERNAL" } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 1 } } } -
{ "meta_info" : { "current_time" : 1640966400000 }, "payload" : { "list" : [ { "id" : 1, "job_id" : 1, "job_type" : "SCENARIO_AUTO_MINING", "data_id" : "DPK0000001", "rank_stamp" : 1640966400000, "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "resource_spec" : "1Core_4GiB", "priority" : 0, "queue_type" : "PROCESSOR", "cluster_type" : "CCE", "cluster_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b" } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 1 } } }
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。