Pipeline - List

Reference

Service:: Data Lake Analytics

API Version:: 2016-11-01

Lists all pipelines.

GET https://{accountName}.{adlaJobDnsSuffix}/pipelines?api-version=2016-11-01

With optional parameters:

GET https://{accountName}.{adlaJobDnsSuffix}/pipelines?startDateTime={startDateTime}&endDateTime={endDateTime}&api-version=2016-11-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The Azure Data Lake Analytics account to execute job operations on.
adlaJobDnsSuffix	path	True	string	Gets the DNS suffix used as the base for all Azure Data Lake Analytics Job service requests.
api-version	query	True	string	Client Api Version.
endDateTime	query		string date-time	The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
startDateTime	query		string date-time	The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.

Responses

Name	Type	Description
200 OK	JobPipelineInformationListResult	Successfully retrieved the list of pipelines.

Examples

Lists all pipelines

Sample Request

HTTP

GET https://account123.contosopipelineservice.com/pipelines?startDateTime=2017-04-18T11:16:49.0748958-07:00&endDateTime=2017-04-18T11:16:49.0748958-07:00&api-version=2016-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "pipelineId": "076713da-9018-41ae-a3bd-9eab14e54d09",
      "pipelineName": "test_pipeline_name",
      "pipelineUri": "https://account123.contosopipelineservice.com/076713da-9018-41ae-a3bd-9eab14e54d09",
      "numJobsFailed": 1,
      "numJobsCanceled": 1,
      "numJobsSucceeded": 1,
      "auHoursFailed": 1,
      "auHoursCanceled": 1,
      "auHoursSucceeded": 1,
      "lastSubmitTime": "2017-04-18T11:16:49.0748958-07:00",
      "runs": [
        {
          "runId": "67034c12-b250-468e-992d-39fb978bde2c",
          "lastSubmitTime": "2017-04-18T11:16:49.0748958-07:00"
        }
      ],
      "recurrences": [
        "2ba01f6c-562d-4246-90ff-0b8c2d10e346",
        "da8dc3de-2fd8-4641-8968-40dbbf11e95f"
      ]
    }
  ],
  "nextLink": "https://account123.contosopipelineservice.com/076713da-9018-41ae-a3bd-9eab14e54d09"
}

Definitions

Name	Description
JobPipelineInformation	Job Pipeline Information, showing the relationship of jobs and recurrences of those jobs in a pipeline.
JobPipelineInformationListResult	List of job pipeline information items.
JobPipelineRunInformation	Run info for a specific job pipeline.

JobPipelineInformation

Job Pipeline Information, showing the relationship of jobs and recurrences of those jobs in a pipeline.

Name	Type	Description
auHoursCanceled	number	the number of job execution hours that resulted in canceled jobs.
auHoursFailed	number	the number of job execution hours that resulted in failed jobs.
auHoursSucceeded	number	the number of job execution hours that resulted in successful jobs.
lastSubmitTime	string	the last time a job in this pipeline was submitted.
numJobsCanceled	integer	the number of jobs in this pipeline that have been canceled.
numJobsFailed	integer	the number of jobs in this pipeline that have failed.
numJobsSucceeded	integer	the number of jobs in this pipeline that have succeeded.
pipelineId	string	the job relationship pipeline identifier (a GUID).
pipelineName	string	the friendly name of the job relationship pipeline, which does not need to be unique.
pipelineUri	string	the pipeline uri, unique, links to the originating service for this pipeline.
recurrences	string[]	the list of recurrence identifiers representing each recurrence in this pipeline.
runs	JobPipelineRunInformation[]	the list of run identifiers representing each run of this pipeline.

JobPipelineInformationListResult

List of job pipeline information items.

Name	Type	Description
nextLink	string	the link (url) to the next page of results.
value	JobPipelineInformation[]	the list of job pipeline information items.

JobPipelineRunInformation

Run info for a specific job pipeline.

Name	Type	Description
lastSubmitTime	string	the time this instance was last submitted.
runId	string	the run identifier of an instance of pipeline executions (a GUID).