查询排队作业列表-QueryQueuedJobList

功能介绍

查询排队作业列表

URI

GET /v1.0/{project_id}/data/queuing-jobs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id，获取方法请参见获取项目ID

表2 Query参数
参数	是否必选	参数类型	描述
job_id	否	Long	作业id
output_type	否	String	输出类型
job_type	否	String	内部作业类型
data_id	否	String	数据id
queue_type	是	String	队列类型
limit	否	Integer	返回个数上限
offset	否	Integer	查询偏移量
processor_name	否	String	算子名称
cluster_type	否	String	集群类型
cluster_id	否	String	集群id，当cluster_type为MODELARTS时，此字段必填

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
payload	DataJobQueuePayload object	实际返回信息
meta_info	RespMetaInfo object	元数据

表5 DataJobQueuePayload
参数	参数类型	描述
list	Array of jobQueueVo objects	队列列表
page_info	PageInfo object	分页信息

表6 jobQueueVo
参数	参数类型	描述
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

表7 PageInfo
参数	参数类型	描述
offset	Integer	查询偏移量
limit	Integer	返回个数上限
total	Integer	资源总数

表8 RespMetaInfo
参数	参数类型	描述
current_time	String	请求时间，UTC时间格式，时间为UTC标准时间

请求示例

获取算子作业队列

GET https://{endpoint}/v1.0/{project_id}/data/queuing-jobs?limit=10&offset=0&queue_type=PROCESSOR

获取内部作业队列

GET https://{endpoint}/v1.0/{project_id}/data/queuing-jobs?limit=10&offset=0&queue_type=INTERNAL

响应示例

状态码：200

查询成功

示例 1

{
  "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
    }
  }
}

示例 2

{
  "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
    }
  }
}