你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Pipeline Runs - Query By Factory

查询管道基于输入筛选器条件在工厂中运行。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns?api-version=2018-06-01

URI 参数

名称 必需 类型 说明
factoryName
path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

工厂名称。

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

资源组名称。

subscriptionId
path True

string

订阅标识符。

api-version
query True

string

API 版本。

请求正文

名称 必需 类型 说明
lastUpdatedAfter True

string (date-time)

运行事件以“ISO 8601”格式更新的时间或之后的时间。

lastUpdatedBefore True

string (date-time)

运行事件以“ISO 8601”格式更新的时间或之前的时间。

continuationToken

string

用于获取下一页结果的延续标记。 第一页的 Null。

filters

RunQueryFilter[]

筛选器列表。

orderBy

RunQueryOrderBy[]

OrderBy 选项的列表。

响应

名称 类型 说明
200 OK

PipelineRunsQueryResponse

还行。

Other Status Codes

CloudError

从 Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

PipelineRuns_QueryByFactory

示例请求

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/queryPipelineRuns?api-version=2018-06-01

{
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
  "filters": [
    {
      "operand": "PipelineName",
      "operator": "Equals",
      "values": [
        "examplePipeline"
      ]
    }
  ]
}

示例响应

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
{
  "value": [
    {
      "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": [],
      "runDimension": {
        "JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3"
      }
    },
    {
      "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
      "pipelineName": "examplePipeline",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "invokedBy": {
        "id": "7c5fd7ef7e8a464b98b931cf15fcac66",
        "name": "Manual"
      },
      "runStart": "2018-06-16T00:39:49.2745128Z",
      "runEnd": null,
      "durationInMs": null,
      "status": "Cancelled",
      "message": "",
      "lastUpdated": "2018-06-16T00:39:51.216097Z",
      "annotations": [],
      "runDimension": {
        "JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab"
      }
    }
  ]
}

定义

名称 说明
CloudError

定义 Azure 数据工厂错误响应结构的对象。

PipelineRun

有关管道运行的信息。

PipelineRunInvokedBy

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

PipelineRunsQueryResponse

列表管道运行。

RunFilterParameters

列出运行的查询参数。

RunQueryFilter

列出运行的查询筛选器选项。

RunQueryFilterOperand

要用于筛选器的参数名称。 允许的作数查询管道运行是 PipelineName、RunStart、RunEnd 和 Status;到查询活动运行的是 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,以及查询触发器运行是 TriggerName、TriggerRunTimestamp 和 Status。

RunQueryFilterOperator

要用于筛选器的运算符。

RunQueryOrder

参数的排序顺序。

RunQueryOrderBy

一个对象,用于按列表运行的选项提供顺序。

RunQueryOrderByField

要用于排序依据的参数名称。 管道运行允许的参数是 PipelineName、RunStart、RunEnd 和 Status;对于活动运行,为 ActivityName、ActivityRunStart、ActivityRunEnd 和 Status;对于触发器运行,为 TriggerName、TriggerRunTimestamp 和 Status。

CloudError

定义 Azure 数据工厂错误响应结构的对象。

名称 类型 说明
error.code

string

错误代码。

error.details

CloudError[]

包含其他错误详细信息的数组。

error.message

string

错误信息。

error.target

string

与错误关联的请求中的属性名称/路径。

PipelineRun

有关管道运行的信息。

名称 类型 说明
durationInMs

integer

管道运行的持续时间。

invokedBy

PipelineRunInvokedBy

启动管道运行的实体。

isLatest

boolean

指示恢复的管道运行是否是其组中的最新运行。

lastUpdated

string (date-time)

管道运行事件的上次更新时间戳ISO8601格式。

message

string

管道运行中的消息。

parameters

object

管道运行中使用的参数名称的完整或部分列表、值对。

pipelineName

string

管道名称。

runDimensions

object

管道运行发出的运行维度。

runEnd

string (date-time)

管道运行的结束时间采用ISO8601格式。

runGroupId

string

关联管道运行的所有恢复运行的标识符。

runId

string

运行的标识符。

runStart

string (date-time)

管道运行的开始时间ISO8601格式。

status

string

管道运行的状态。 可能的值:Queued、InProgress、Succeeded、Failed、Canceling、Canceled

PipelineRunInvokedBy

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

名称 类型 说明
id

string

启动运行的实体的 ID。

invokedByType

string

启动运行的实体的类型。

name

string

启动管道运行的实体的名称。

pipelineName

string

触发运行的管道的名称(如果有)。

pipelineRunId

string

触发运行的管道的运行 ID(如果有)。

PipelineRunsQueryResponse

列表管道运行。

名称 类型 说明
continuationToken

string

获取下一页结果的延续标记(如果存在任何剩余的结果),否则为 null。

value

PipelineRun[]

管道运行列表。

RunFilterParameters

列出运行的查询参数。

名称 类型 说明
continuationToken

string

用于获取下一页结果的延续标记。 第一页的 Null。

filters

RunQueryFilter[]

筛选器列表。

lastUpdatedAfter

string (date-time)

运行事件以“ISO 8601”格式更新的时间或之后的时间。

lastUpdatedBefore

string (date-time)

运行事件以“ISO 8601”格式更新的时间或之前的时间。

orderBy

RunQueryOrderBy[]

OrderBy 选项的列表。

RunQueryFilter

列出运行的查询筛选器选项。

名称 类型 说明
operand

RunQueryFilterOperand

要用于筛选器的参数名称。 允许的作数查询管道运行是 PipelineName、RunStart、RunEnd 和 Status;到查询活动运行的是 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,以及查询触发器运行是 TriggerName、TriggerRunTimestamp 和 Status。

operator

RunQueryFilterOperator

要用于筛选器的运算符。

values

string[]

筛选器值列表。

RunQueryFilterOperand

要用于筛选器的参数名称。 允许的作数查询管道运行是 PipelineName、RunStart、RunEnd 和 Status;到查询活动运行的是 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,以及查询触发器运行是 TriggerName、TriggerRunTimestamp 和 Status。

说明
PipelineName
Status
RunStart
RunEnd
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

要用于筛选器的运算符。

说明
Equals
NotEquals
In
NotIn

RunQueryOrder

参数的排序顺序。

说明
ASC
DESC

RunQueryOrderBy

一个对象,用于按列表运行的选项提供顺序。

名称 类型 说明
order

RunQueryOrder

参数的排序顺序。

orderBy

RunQueryOrderByField

要用于排序依据的参数名称。 管道运行允许的参数是 PipelineName、RunStart、RunEnd 和 Status;对于活动运行,为 ActivityName、ActivityRunStart、ActivityRunEnd 和 Status;对于触发器运行,为 TriggerName、TriggerRunTimestamp 和 Status。

RunQueryOrderByField

要用于排序依据的参数名称。 管道运行允许的参数是 PipelineName、RunStart、RunEnd 和 Status;对于活动运行,为 ActivityName、ActivityRunStart、ActivityRunEnd 和 Status;对于触发器运行,为 TriggerName、TriggerRunTimestamp 和 Status。

说明
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp