更新时间:2023-10-16 GMT+08:00

查询作业exe对象列表(废弃)

功能介绍

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

URI

  • URI格式

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

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

    名称

    是否必选

    说明

    project_id

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

请求参数

表2 请求参数说明

名称

是否必选

参数类型

说明

cluster_id

String

集群编号。

id

String

作业执行对象的编号。

page_size

Integer

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

取值范围:[1~100]

current_page

Integer

当前查询页码。

job_name

String

作业名称。

state

Integer

作业状态编码:

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

响应参数

表3 响应参数说明

参数名

参数类型

说明

totalRecord

Integer

作业列表总数。

job_executions

Array

作业列表参数,请参见表4

表4 job_executions参数说明

参数名

参数类型

说明

id

String

作业ID。

create_at

Integer

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

update_at

Integer

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

tenant_id

String

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

job_id

String

Yarn的作业ID。

job_name

String

作业名称。

start_time

Integer

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

end_time

Integer

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

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:HiveQL(当前不支持)
  • 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

Integer

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

step_name

String

作业步骤名。

step_num

Integer

步骤数量。

task_num

Integer

任务数量。

update_by

String

更新作业的用户ID。

spend_time

Integer

作业执行持续时间,单位:秒。

step_seq

Integer

步骤序列号。

progress

String

作业执行进度。

示例

  • 请求示例
    GET/v1.1/{project_id}/job-exes?page_size=10&current_page=1&state=3&job_name=myfirstjob&clusterId=20ca8601-72a2-4570-b788-2a20fec81a95
  • 响应示例
    {
        "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对象列表成功。

异常状态码请参见状态码