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

调试

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

请求参数

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

系统规定参数。取值：ListFlowJobHistory。

RegionId String 是 cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
ProjectId String 是 FP-3535FE0BE5228***

项目ID。您可以调用ListFlowProject查看项目的ID。
Id String 否 FJ-1A2FB31D8295****

作业ID。您可以调用ListFlowJob查看作业ID。
JobType String 否 SPARK

作业的类型，可能的取值有：SPARK，SPARK_STREAMING，ZEPPELIN
InstanceId String 否 FJI-BCCAE48B90CC****

作业实例ID。您可以调用DescribeFlowJob查看作业实例ID。
TimeRange String 否 {"type":"range","from":1564416000000,"to":1567008000000}

查询的时间范围参数，参数列表：type: range，from: 开始时间（long型时间戳），to: 结束时间（long型时间戳）
PageNumber Integer 否 1

当前页码。
PageSize Integer 否 20

分页查询时每页行数。

返回数据

名称 类型 示例值 描述
RequestId String F5540D8F-06E8-4E3C-B47A-D75CED72A795

请求ID。
PageNumber Integer 1

当前页码。
PageSize Integer 20

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

记录总数。
NodeInstances Array of NodeInstance

作业实例列表。
NodeInstance
Type String START

节点类型：JOB：作业，CLUSTER：集群，START：开始，END：结束
Status String PREP

实例的执行状态：PREP：准备启动，SUBMITTING：提交中，RUNNING：运行中DONE：已完成，OK：执行成功，FAILED：执行失败，KILLED：已终止，KILL_FAILED：终止失败，START_RETRY：开始重试
pending Boolean true

是否结束。
EnvConf String {"key":"value"}

环境变量设置。
RetryInterval Long 200

重试间隔 0-300（秒）。
ProjectId String FP-3535FE0BE522****

项目ID。
JobType String SPARK

作业类型。
GmtModified Long 1540796236000

创建时间。
ExternalInfo String empty

外部信息。例如，运行作业的错误诊断信息。
ExternalStatus String SUBMITTED

实例对应的Container的状态：SUBMITTED, RUNNING, SUCCESS, FAIL, KILL_FAIL, KILL_SUCCESS
JobName String my_job_name

作业名称。
ExternalId String application_1541559535023_3****

启动器的application的ID。
MaxRetry Integer 3

最大重试次数。
ClusterId String C-A6C9F4F1E9EC****

集群ID。
FailAct String STOP

失败策略，可能的取值：CONTINUE（提过本次作业），STOP（停止作业）
JobParams String oss://bucket_name/example.jar

作业内容。
ParamConf String {"date":"${yyyy-MM-dd}"}

参数设置。
HostName String 无

保留参数。
Retries Integer 0

重试次数。
EndTime Long 1540796248000

运行结束时间。
StartTime Long 1540796489000

运行开始时间。
RunConf String {"priority":1,"userName":"hadoop","memory":2048,"cores":1}

运行配置，取值如下：priority（优先级），userName（任务的Linux提交用户），memory（内存，单位为MB），cores（核数）
NodeName String 无

保留参数。
JobId String FJ-A23BD131A862****

作业ID。
GmtCreate Long 1540796236000

创建时间。
Id String FJI-F4FC53D7207E****

作业实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlowJobHistory
&RegionId=cn-hangzhou
&ProjectId=FP-3535FE0BE5228***
&Id=FJ-1A2FB31D8295****
&JobType=SPARK
&InstanceId=FJI-BCCAE48B90CC****
&TimeRange={"type":"range","from":1564416000000,"to":1567008000000}
&PageNumber=1
&PageSize=20
&StatusList=["[\"FAILED\"]"]
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFlowJobHistoryResponse>
    <RequestId>F5540D8F-06E8-4E3C-B47A-D75CED72A795</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <Total>12</Total>
    <NodeInstances>
        <Type>START</Type>
        <Status>PREP</Status>
        <pending>true</pending>
        <EnvConf>{"key":"value"}</EnvConf>
        <RetryInterval>200</RetryInterval>
        <ProjectId>FP-3535FE0BE522****</ProjectId>
        <JobType>SPARK</JobType>
        <GmtModified>1540796236000</GmtModified>
        <ExternalInfo>empty</ExternalInfo>
        <ExternalStatus>SUBMITTED</ExternalStatus>
        <JobName>my_job_name</JobName>
        <ExternalId>application_1541559535023_3****</ExternalId>
        <MaxRetry>3</MaxRetry>
        <ClusterId>C-A6C9F4F1E9EC****</ClusterId>
        <FailAct>STOP</FailAct>
        <JobParams>oss://bucket_name/example.jar</JobParams>
        <ParamConf>{"date":"${yyyy-MM-dd}"}</ParamConf>
        <HostName>无</HostName>
        <Retries>0</Retries>
        <EndTime>1540796248000</EndTime>
        <StartTime>1540796489000</StartTime>
        <RunConf>{"priority":1,"userName":"hadoop","memory":2048,"cores":1}</RunConf>
        <NodeName>无</NodeName>
        <JobId>FJ-A23BD131A862****</JobId>
        <GmtCreate>1540796236000</GmtCreate>
        <Id>FJI-F4FC53D7207E****</Id>
    </NodeInstances>
</ListFlowJobHistoryResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F5540D8F-06E8-4E3C-B47A-D75CED72A795",
  "PageNumber" : 1,
  "PageSize" : 20,
  "Total" : 12,
  "NodeInstances" : [ {
    "Type" : "START",
    "Status" : "PREP",
    "pending" : true,
    "EnvConf" : "{\"key\":\"value\"}",
    "RetryInterval" : 200,
    "ProjectId" : "FP-3535FE0BE522****",
    "JobType" : "SPARK",
    "GmtModified" : 1540796236000,
    "ExternalInfo" : "empty",
    "ExternalStatus" : "SUBMITTED",
    "JobName" : "my_job_name",
    "ExternalId" : "application_1541559535023_3****",
    "MaxRetry" : 3,
    "ClusterId" : "C-A6C9F4F1E9EC****",
    "FailAct" : "STOP",
    "JobParams" : "oss://bucket_name/example.jar",
    "ParamConf" : "{\"date\":\"${yyyy-MM-dd}\"}",
    "HostName" : "无",
    "Retries" : 0,
    "EndTime" : 1540796248000,
    "StartTime" : 1540796489000,
    "RunConf" : "{\"priority\":1,\"userName\":\"hadoop\",\"memory\":2048,\"cores\":1}",
    "NodeName" : "无",
    "JobId" : "FJ-A23BD131A862****",
    "GmtCreate" : 1540796236000,
    "Id" : "FJI-F4FC53D7207E****"
  } ]
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。