Pipeline Run - Get Pipeline Run

服务:

Synapse

API 版本:

2020-12-01

按管道运行 ID 获取管道运行。

GET {endpoint}/pipelineruns/{runId}?api-version=2020-12-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	工作区开发终结点，例如 https://myworkspace.dev.azuresynapse.net。
runId	path	True	string	管道运行标识符。
api-version	query	True	string	Synapse 客户端 API 版本。

响应

名称	类型	说明
200 OK	PipelineRun	还行。
Other Status Codes	CloudError	从 Azure Synapse 服务收到的错误响应。

示例

PipelineRuns_Get

示例请求

HTTP

GET exampleWorkspace.dev.azuresynapse.net/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b?api-version=2020-12-01

示例响应

状态代码:

200

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": []
}

定义

名称	说明
CloudError	定义 Azure Synapse 错误响应结构的对象。
PipelineRun	有关管道运行的信息。
PipelineRunInvokedBy	提供启动管道运行的实体名称和 ID。

CloudError

Object

定义 Azure Synapse 错误响应结构的对象。

名称	类型	说明
error.code	string	错误代码。
error.details	CloudError[]	包含其他错误详细信息的数组。
error.message	string	错误信息。
error.target	string	与错误关联的请求中的属性名称/路径。

PipelineRun

Object

有关管道运行的信息。

名称	类型	说明
durationInMs	integer	管道运行的持续时间。
invokedBy	PipelineRunInvokedBy	启动管道运行的实体。
isLatest	boolean	指示恢复的管道运行是否是其组中的最新运行。
lastUpdated	string (date-time)	管道运行事件的上次更新时间戳ISO8601格式。
message	string	管道运行中的消息。
parameters	object	管道运行中使用的参数名称的完整或部分列表、值对。
pipelineName	string	管道名称。
runEnd	string (date-time)	管道运行的结束时间采用ISO8601格式。
runGroupId	string	关联管道运行的所有恢复运行的标识符。
runId	string	运行的标识符。
runStart	string (date-time)	管道运行的开始时间ISO8601格式。
status	string	管道运行的状态。

PipelineRunInvokedBy

Object

提供启动管道运行的实体名称和 ID。

名称	类型	说明
id	string	启动运行的实体的 ID。
invokedByType	string	启动运行的实体的类型。
name	string	启动管道运行的实体的名称。