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

调试

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

请求参数

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

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

ProjectId String FP-257A173659F5****

项目ID。

RegionId String cn-hangzhou

地域ID。

Id String FJ-BCCAE48B90CC****

作业ID。

StatusList.N RepeatList ["FAILED"]

状态列表:

  • FAILED
  • KILLED
  • KILL_FAILED
  • PREP
  • SUBMITTING
  • RUNNING
  • START_RETRY
  • OK
  • DONE
  • TIMEOUT
JobType String SHELL

作业类型。

InstanceId String FJI-BCCAE48B90CCB37B

作业实例ID。

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

查询时间范围。

PageNumber Integer 1

页码。

PageSize Integer 20

每页查询数量。

返回数据

名称 类型 示例值 描述
NodeInstances Array

作业实例列表。

NodeInstance
ClusterId String C-A6C9F4F1E9EC****

集群ID。

EndTime Long 1540796248000

运行结束时间。

EnvConf String {"key":"value"}

环境变量。

ExternalId String application_1541559535023_34027

启动器的application的ID。

ExternalInfo String empty

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

ExternalStatus String SUCCESS

外部状态:

  • 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。支持MasterGateway机器。hostname格式为emr-header-1.cluster-12345。可登录机器用hostname命令查看对应的值。

Id String FNI-9D14A7CCF268****

作业实例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

重试次数。

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

是否结束。

PageNumber Integer 1

页码。

PageSize Integer 20

每页数量。

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

请求ID。

Total Integer 12

总数。

示例

请求示例

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

正常返回示例

XML 格式

<ListFlowJobHistoryResponse>
  <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_0003</ExternalId>
			      <pending>false</pending>
			      <JobName>success</JobName>
			      <GmtModified>1542957514000</GmtModified>
			      <StartTime>1542957499000</StartTime>
			      <ProjectId>FP-17AB3389E1AD9A34</ProjectId>
			      <MaxRetry>0</MaxRetry>
			      <ParamConf>{"cyctime":"2018-11-23 15:18:19"}</ParamConf>
			      <ExternalStatus>SUCCESS</ExternalStatus>
			      <GmtCreate>1542957499000</GmtCreate>
			      <JobType>SHELL</JobType>
			      <ExternalInfo></ExternalInfo>
			      <Retries>0</Retries>
			      <RetryInterval>0</RetryInterval>
			      <Id>FJI-F4FC53D7207E****</Id>
			      <HostName>emr-header-2.cluster-50016****</HostName>
			      <JobId>FJ-31BD66C7BC502815</JobId>
		    </NodeInstance>
	  </NodeInstances>
	

</ListFlowJobHistoryResponse>

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_0003",
                "pending": false,
                "JobName": "success",
                "GmtModified": 1542957514000,
                "StartTime": 1542957499000,
                "ProjectId": "FP-17AB3389E1AD9A34",
                "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-31BD66C7BC502815"
            }
        ]
    }
}

错误码

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