查询作业列表

功能介绍

查询当前用户的作业列表，可以根据作业ID作为ID，查询大于ID或小于ID的限定条数的作业，默认查询全部状态的作业，也可以设定运行中或其他状态条件。

URI

• URI格式

  GET /v1.0/{project_id}/streaming/jobs

• 参数说明

  表1 URI参数说明

  参数名称	是否必选	参数类型	说明
  project_id	是	String	项目编号，用于资源隔离。获取方式请参考获取项目ID。

  表2 query参数说明

  参数名称	是否必选	参数类型	说明
  job_type	否	String	作业类型： flink_sql_job：flink sql作业 flink_jar_job：flink自定义作业
  status	否	String	作业状态码。 作业的状态如下： job_init：草稿 job_submitting：提交中 job_submit_fail：提交失败 job_running：运行中（提交作业后，返回正常结果） job_running_exception：运行异常（作业发生运行时异常，停止运行作业） job_downloading：下载中 job_idle：空闲 job_canceling：停止中 job_cancel_success：已停止 job_cancel_fail：停止失败 job_savepointing：保存点创建中 job_finish：已完成
  queue_name	否	String	队列名称。
  order	否	String	查询结果排序。 asc：按照时间顺序升序排列 desc：按照时间顺序降序排列 默认为“desc”。
  limit	否	Integer	返回的数据条数。默认为“10”，最大值为“100”。
  name	否	String	作业名称。长度限制：0-57个字符。
  offset	否	Integer	作业偏移量。
  show_detail	否	Boolean	是否返回作业详情信息。默认为“false”。为“true”时，返回作业详情。具体可见查询作业详情。
  user_name	否	String	用户名，可作为筛选条件。
  tags	否	String	指定标签过滤。

请求消息

无请求参数。

响应消息

请求示例

无

响应示例

{
    "is_success": "true",
    "message": "作业列表查询成功",
    "job_list": {
        "total_count": 26,
        "jobs": [
            {
                "job_id": 146,
                "name": "aaaaa",
                "desc": "",
                "user_name": "",
                "job_type": "flink_sql_job",
                "status": "job_init",
                "status_desc": "",
                "create_time": 1578892414688,
                "duration": 0,
                "root_id": -1,
                "graph_editor_enabled": false,
                "has_savepoint": false
            }
        ]
    }
}

状态码

状态码如表7所示。

错误码

调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。