调用ListFlowJobHistory接口,查询作业的运行实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFlowJobHistory

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值:ListFlowJobHistory。

ProjectId String FP-257A173659F5****

项目ID。您可以调用ListFlowProject查看项目的ID。

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Id String FJ-BCCAE48B90CC****

作业ID。您可以调用ListFlowJob查看。

StatusList.N RepeatList ["FAILED"]

状态列表:

  • SUBMITTED:已提交
  • RUNNING:运行中
  • SUCCESS:执行成功
  • FAILED:执行失败
  • KILL_FAILED:终止失败
  • KILL_SUCCESS:终止成功
JobType String SHELL

作业类型。支持:SPARK_SQL、SPARK_STREAMING、MR、SQOOP、PIG、FLINK、STREAMING_SQL、IMPALA_SQL、PRESTO_SQL、SPARK、Hive_SQL、Hive、SHELL及SPARK_SHELL。

InstanceId String FJI-BCCAE48B90CC****

节点实例ID。您可以调用ListFlowNodeInstance查看节点实例ID。

TimeRange String {"type":"range","from":1564416000000,"to":1567008000000}

查询的时间范围参数,参数列表:

  • type:range
  • from:开始时间(long型)
  • to:结束时间(long型)
PageNumber Integer 1

当前页码,从1开始。

PageSize Integer 20

分页查询时设置的每页行数。

返回数据

名称 类型 示例值 描述
NodeInstances Array of NodeInstance

作业实例列表。

NodeInstance
ClusterId String C-A6C9F4F1E9EC****

集群ID。

EndTime Long 1540796248000

运行结束时间。

EnvConf String {"key":"value"}

环境变量。

ExternalId String application_1541559535023_3****

启动器的application的ID。

ExternalInfo String empty

外部信息。例如,运行作业的错误诊断信息。

ExternalStatus String SUCCESS

实例对应的Container的状态:

  • SUBMITTED:已提交
  • RUNNING:运行中
  • SUCCESS:执行成功
  • FAIL:执行失败
  • KILL_FAIL:终止失败
  • KILL_SUCCESS:终止成功
FailAct String STOP

失败策略:

  • STOP:终止工作流
  • CONTINUE:跳过
GmtCreate Long 1540796236000

创建时间。

GmtModified Long 1540796247000

修改时间。

HostName String emr-header-1.cluster-12345

节点实例运行所在主机的名称。您可以登录主机使用hostname命令查看主机名称。

Id String FJI-F4FC53D7207E****

作业实例ID。

JobId String FJ-A23BD131A862****

作业ID。

JobName String myJob

作业名称。

JobParams String ls -l

作业内容。

JobType String HIVE_SQL

作业类型。

MaxRetry Integer 0

最大重试次数。

NodeName String 为空

节点名称。

ParamConf String {"date":"${yyyy-MM-dd}"}

参数配置。

ProjectId String FP-3535FE0BE522****

项目ID。

Retries Integer 0

重试次数。

RetryInterval Long 200

重试间隔 0-300(秒)。

RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

运行配置:

  • priority:优先级。
  • userName:提交作业的Linux用户。
  • memory:内存单位为MB。
  • cores:核数。
StartTime Long 1540796237000

运行开始时间。

Status String OK

实例的执行状态:

  • PREP:等待启动
  • SUBMITTING:提交中
  • RUNNING:运行中
  • DONE:已完成
  • OK:执行成功
  • FAILED:执行失败
  • KILLED:已终止
  • KILL_FAILED:终止失败
  • START_RETRY:开始重试
Type String JOB

节点类型:

  • JOB:作业
  • CLUSTER:集群
  • START:开始
  • END:结束
pending Boolean false

是否结束:

  • true:结束
  • false:不结束
PageNumber Integer 1

当前页码。

PageSize Integer 20

分页查询时设置的每页行数。

RequestId String F5540D8F-06E8-4E3C-B47A-D75CED72A795

请求ID。

Total Integer 12

总数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlowJobHistory
&ProjectId=FP-257A173659F5****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<PageSize>10</PageSize>
<RequestId>BCF52B64-007F-4883-BAEA-0499106D07C2</RequestId>
<PageNumber>1</PageNumber>
<Total>1</Total>
<NodeInstances>
    <NodeInstance>
        <FailAct>STOP</FailAct>
        <Status>OK</Status>
        <EndTime>1542957514000</EndTime>
        <ClusterId>C-A6C9F4F1E9EC****</ClusterId>
        <ExternalId>application_1542955685866_****</ExternalId>
        <pending>false</pending>
        <JobName>success</JobName>
        <GmtModified>1542957514000</GmtModified>
        <StartTime>1542957499000</StartTime>
        <ProjectId>FP-17AB3389E1AD****</ProjectId>
        <MaxRetry>0</MaxRetry>
        <ParamConf>{"cyctime":"2018-11-23 15:18:19"}</ParamConf>
        <ExternalStatus>SUCCESS</ExternalStatus>
        <GmtCreate>1542957499000</GmtCreate>
        <JobType>SHELL</JobType>
        <ExternalInfo/>
        <Retries>0</Retries>
        <RetryInterval>0</RetryInterval>
        <Id>FJI-F4FC53D7207E****</Id>
        <HostName>emr-header-2.cluster-50016****</HostName>
        <JobId>FJ-31BD66C7BC50****</JobId>
    </NodeInstance>
</NodeInstances>

JSON格式

{
    "PageSize": 10,
    "RequestId": "BCF52B64-007F-4883-BAEA-0499106D07C2",
    "PageNumber": 1,
    "Total": 1,
    "NodeInstances": {
        "NodeInstance": [
            {
                "FailAct": "STOP",
                "Status": "OK",
                "EndTime": 1542957514000,
                "ClusterId": "C-A6C9F4F1E9EC****",
                "ExternalId": "application_1542955685866_****",
                "pending": false,
                "JobName": "success",
                "GmtModified": 1542957514000,
                "StartTime": 1542957499000,
                "ProjectId": "FP-17AB3389E1AD****",
                "MaxRetry": 0,
                "ParamConf": "{\"cyctime\":\"2018-11-23 15:18:19\"}",
                "ExternalStatus": "SUCCESS",
                "GmtCreate": 1542957499000,
                "JobType": "SHELL",
                "ExternalInfo": "",
                "Retries": 0,
                "RetryInterval": 0,
                "Id": "FJI-F4FC53D7207E****",
                "HostName": "emr-header-2.cluster-50016****",
                "JobId": "FJ-31BD66C7BC50****"
            }
        ]
    }
}