Pipeline Run - Get Pipeline Run
Get a pipeline run by its run ID.
GET {endpoint}/pipelineruns/{runId}?api-version=2020-12-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
The workspace development endpoint, for example |
run
|
path | True |
string |
The pipeline run identifier. |
api-version
|
query | True |
string |
The Synapse client API Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Synapse service. |
Examples
PipelineRuns_Get
Sample request
GET exampleWorkspace.dev.azuresynapse.net/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b?api-version=2020-12-01
Sample response
Date: Sat, 16 Jun 2018 00:40:02 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14988
x-ms-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646
x-ms-correlation-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646
{
"runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
"pipelineName": "examplePipeline",
"parameters": {
"OutputBlobNameList": "[\"exampleoutput.csv\"]"
},
"invokedBy": {
"id": "80a01654a9d34ad18b3fcac5d5d76b67",
"name": "Manual"
},
"runStart": "2018-06-16T00:37:44.6257014Z",
"runEnd": "2018-06-16T00:38:12.7314495Z",
"durationInMs": 28105,
"status": "Succeeded",
"message": "",
"lastUpdated": "2018-06-16T00:38:12.7314495Z",
"annotations": []
}
Definitions
Name | Description |
---|---|
Cloud |
The object that defines the structure of an Azure Synapse error response. |
Pipeline |
Information about a pipeline run. |
Pipeline |
Provides entity name and id that started the pipeline run. |
CloudError
The object that defines the structure of an Azure Synapse error response.
Name | Type | Description |
---|---|---|
error.code |
string |
Error code. |
error.details |
Array with additional error details. |
|
error.message |
string |
Error message. |
error.target |
string |
Property name/path in request associated with error. |
PipelineRun
Information about a pipeline run.
Name | Type | Description |
---|---|---|
durationInMs |
integer |
The duration of a pipeline run. |
invokedBy |
Entity that started the pipeline run. |
|
isLatest |
boolean |
Indicates if the recovered pipeline run is the latest in its group. |
lastUpdated |
string |
The last updated timestamp for the pipeline run event in ISO8601 format. |
message |
string |
The message from a pipeline run. |
parameters |
object |
The full or partial list of parameter name, value pair used in the pipeline run. |
pipelineName |
string |
The pipeline name. |
runEnd |
string |
The end time of a pipeline run in ISO8601 format. |
runGroupId |
string |
Identifier that correlates all the recovery runs of a pipeline run. |
runId |
string |
Identifier of a run. |
runStart |
string |
The start time of a pipeline run in ISO8601 format. |
status |
string |
The status of a pipeline run. |
PipelineRunInvokedBy
Provides entity name and id that started the pipeline run.
Name | Type | Description |
---|---|---|
id |
string |
The ID of the entity that started the run. |
invokedByType |
string |
The type of the entity that started the run. |
name |
string |
Name of the entity that started the pipeline run. |