You can call this operation to query the running instances of a job.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required ListFlowJobHistory

The operation that you want to perform. For API requests using the HTTP or HTTPS URL, this parameter is required. Set the value to ListFlowJobHistory.

ProjectId String Required FP-257A173659F5****

The ID of the project.

RegionId String Required cn-hangzhou

The region ID of the instance.

Id String No FJ-BCCAE48B90CC****

The ID of the job.

StatusList.N RepeatList No ["FAILED"]

The status of the job instance. Valid values:

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

The type of the job.

InstanceId String No FJI-BCCAE48B90CC****

The ID of the job instance.

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

The time range for querying the job instance.

PageNumber Integer Optional 1

The page number of the page to be returned.

PageSize Integer Optional 20

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
NodeInstances Array

The list of job instances.

NodeInstance
ClusterId String C- A6C9F4F1E9EC****

The ID of the HPC cluster.

EndTime Long 1540796248000

The time when the execution of the job instance ended.

EnvConf String {"key":"value"}

The environment variables configured for the job.

ExternalId String application_1541559535023_3****

The initiator's application ID.

ExternalInfo String empty

External information. Such as error diagnosis information of a running job.

ExternalStatus String SUCCESS

The status of the Container corresponding to the instance:

  • SUBMITTED
  • RUNNING
  • SUCCESS
  • FAIL
  • KILL_FAIL
  • KILL_SUCCESS
FailAct String STOP

The action to take upon an operation failure of the node instance. Valid values:

  • STOP (terminates the workflow)
  • CONTINUE
GmtCreate Long 1540796236000

The creation time of the project.

GmtModified Long 1540796247000

The time when the workflow node instance was modified.

HostName String emr-header-1.cluster-12345

The name of the host on which the node instance runs. You can log in to the host to use hostname command to view hostname.

Id String FNI-9D14A7CCF268****

The ID of the job instance.

JobId String FJ-A23BD131A862****

The ID of the job.

JobName String myJob

The name of the job.

JobParams String ls -l

The content of the job.

JobType String HIVE_SQL

The type of the job.

MaxRetry Integer 0

The maximum number of times the job can be retried.

NodeName String Empty

The name of the node.

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

The configuration parameters of the job.

ProjectId String FP-3535FE0BE522****

The ID of the project.

Retries Integer 0

The number of retries of running the node instance.

RetryInterval Long 200

The interval between successive retries of running the node instance.

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

The scheduling parameters configured for the job.

  • priority: the priority of the job.
  • userName: the name of the Linux user who summits the job.
  • memory: the memory allocated to the job. Unit: MB.
  • cores: the number of vCPUs allocated to the job.
StartTime Long 1540796237000

The time when the execution of the job instance started.

Status String OK

The execution status of the instance. Valid values:

  • PREP (pending start)
  • SUBMITTING
  • RUNNING
  • DONE
  • OK (executed successfully)
  • FAILED
  • KILLED
  • KILL_FAILED
  • START_RETRY
Type String JOB

The type of the node. Valid values:

  • JOB
  • CLUSTER
  • START
  • END
pending Boolean false

End of:

  • Yes
  • false
PageNumber Integer 1

The page number of the page to be returned.

PageSize Integer 20

The page number of the returned page.

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

The ID of the instance.

Total Interger 12

The total number of returned entries.

Examples

Sample request

http(s)://[Endpoint]/? Action=ListFlowJobHistory
&ProjectId=FP-257A173659F5****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes.

For a list of error codes, visit the API Error Center.