文档首页/ MapReduce服务 MRS/ API参考/ 历史API/ 作业接口管理（废弃）/ 查询作业exe对象列表（废弃）
更新时间：2024-12-10 GMT+08:00
查看PDF
分享

查询作业exe对象列表（废弃）

功能介绍

查询所有作业的exe对象列表。该接口不兼容Sahara。

URI

  • URI格式

    GET /v1.1/{project_id}/job-exes

  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    项目编号。获取方法，请参见获取项目ID。

    约束限制：

    不涉及

    取值范围：

    不涉及

    默认取值：

    不涉及

请求参数

表2 请求参数说明

名称

是否必选

参数类型

说明

page_size

否

String

参数解释：

分页查询每页返回的最大作业数量。

约束限制：

不涉及

取值范围：

1～100

默认取值：

不涉及

current_page

否

String

参数解释：

当前查询页码。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_name

否

String

参数解释：

作业名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cluster_id

是

String

参数解释：

集群编号。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

state

否

String

参数解释：

作业状态编码。

约束限制：

不涉及

取值范围：

  • -1：Terminated表示已终止的作业状态。
  • 2：Running表示运行中的作业状态。
  • 3：Completed表示已完成的作业状态。
  • 4：Abnormal表示异常的作业状态。

默认取值：

不涉及

id

否

String

参数解释：

作业执行对象的编号。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

表3 响应参数说明

参数名

参数类型

说明

totalRecord

Integer

参数解释：

作业列表总数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_executions

Array

参数解释：

作业列表参数，请参见表4。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 job_executions参数说明

参数名

参数类型

说明

id

String

参数解释：

作业ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_at

Long

参数解释：

作业创建时间，十三位时间戳。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

update_at

Long

参数解释：

作业更新时间，十三位时间戳。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tenant_id

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_id

String

参数解释：

作业ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_name

String

参数解释：

作业名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

start_time

Long

参数解释：

作业执行开始时间，十三位时间戳。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

end_time

Long

参数解释：

作业执行结束时间，十三位时间戳。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cluster_id

String

参数解释：

作业所属集群ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

group_id

String

参数解释：

作业执行组ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

jar_path

String

参数解释：

执行程序jar包或sql文件地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

input

String

参数解释：

数据输入地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

output

String

参数解释：

数据输出地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_log

String

参数解释：

作业日志存储地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_type

Integer

参数解释：

作业类型码。

约束限制：

不涉及

取值范围：

  • 1：MapReduce
  • 2：Spark
  • 3：Hive Script
  • 4：HiveSQL（当前不支持）
  • 5：DistCp
  • 6：Spark Script
  • 7：Spark SQL（该接口当前不支持）

默认取值：

不涉及

file_action

String

参数解释：

导入导出数据。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

arguments

String

参数解释：

程序执行的关键参数。

约束限制：

该参数由用户程序内的函数指定，MRS只负责参数的传入。

取值范围：

该参数可为空。

默认取值：

不涉及

hql

String

参数解释：

HQL脚本语句。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_state

Integer

参数解释：

作业状态编码。

约束限制：

不涉及

取值范围：

  • -1：Terminated表示已终止的作业状态。
  • 2：Running表示运行中的作业状态。
  • 3：Completed表示已完成的作业状态。
  • 4：Abnormal表示异常的作业状态。

默认取值：

不涉及

job_final_status

Integer

参数解释：

作业最终状态码。

  • 0：未完成。
  • 1：执行错误，终止执行。
  • 2：执行完成并且成功。
  • 3：已取消。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

hive_script_path

String

参数解释：

Hive脚本地址。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_by

String

参数解释：

创建作业的用户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

finished_step

Integer

参数解释：

当前已完成的步骤数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_main_id

String

参数解释：

作业主ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

job_step_id

String

参数解释：

作业步骤ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

postpone_at

Long

参数解释：

延迟时间，十三位时间戳。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

step_name

String

参数解释：

作业步骤名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

step_num

Integer

参数解释：

步骤数量。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

task_num

Integer

参数解释：

任务数量。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

update_by

String

参数解释：

更新作业的用户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

spend_time

Float

参数解释：

作业执行持续时间，单位：秒。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

step_seq

Integer

参数解释：

步骤序列号。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

progress

String

参数解释：

作业执行进度。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

查询作业exe对象列表请求示例

GET https://{endpoint}/v1.1/{project_id}/job-exes?page_size=10&current_page=1&state=3&job_name=myfirstjob&clusterId=20ca8601-72a2-4570-b788-2a20fec81a95

响应示例

状态码： 200

查询作业exe对象列表成功。

{
  "totalRecord" : "14",
  "job_executions" : [ {
    "id" : "669476bd-89d2-45aa-8f1a-872d16de377e",
    "create_at" : "1484641003707",
    "update_at" : "1484641003707",
    "tenant_id" : "3f99e3319a8943ceb15c584f3325d064",
    "job_id" : "",
    "job_name" : "myfirstjob",
    "start_time" : "1484641003707",
    "end_time" : null,
    "cluster_id" : "2b460e01-3351-4170-b0a7-57b9dd5ffef3",
    "group_id" : "669476bd-89d2-45aa-8f1a-872d16de377e",
    "jar_path" : "s3a://jp-test1/program/hadoop-mapreduce-examples-2.4.1.jar",
    "input" : "s3a://jp-test1/input/",
    "output" : "s3a://jp-test1/output/",
    "job_log" : "s3a://jp-test1/joblogs/",
    "job_type" : "1",
    "file_action" : "",
    "arguments" : "wordcount",
    "hql" : "",
    "job_state" : "2",
    "job_final_status" : "1",
    "hive_script_path" : null,
    "create_by" : "3f99e3319a8943ceb15c584f3325d064",
    "finished_step" : "0",
    "job_main_id" : "",
    "job_step_id" : "",
    "postpone_at" : "1484641003174",
    "step_name" : "",
    "step_num" : "0",
    "task_num" : "0",
    "update_by" : "3f99e3319a8943ceb15c584f3325d064",
    "spend_time" : null,
    "step_seq" : "222",
    "progress" : "first progress"
  } ]
}

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

查询作业exe对象列表成功。

异常状态码请参见状态码。

错误码

请参见错误码。