調用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****"
  } ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

訪問錯誤中心查看更多錯誤碼。