通过

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

Activity Runs - Query By Pipeline Run

  • 参考
服务:
Data Factory
API 版本:
2018-06-01

查询活动基于输入筛选条件运行。

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

URI 参数

名称 在 必需 类型 说明
factoryName
 path True

string

工厂名称。

正则表达式模式: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName
 path True

string

资源组名称。

正则表达式模式: ^[-\w\._\(\)]+$
runId
 path True

string

管道运行标识符。
subscriptionId
 path True

string

订阅标识符。
api-version
 query True

string

API 版本。

请求正文

名称 必需 类型 说明
lastUpdatedAfter True

string

以“ISO 8601”格式更新运行事件的时间。
lastUpdatedBefore True

string

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

string

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

RunQueryFilter[]

筛选器列表。
orderBy

RunQueryOrderBy[]

OrderBy 选项的列表。

响应

名称 类型 说明
200 OK

ActivityRunsQueryResponse

没问题。
Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ActivityRuns_QueryByPipelineRun

示例请求

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b/queryActivityruns?api-version=2018-06-01

{
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
}

示例响应

状态代码:
200 
Date: Sat, 16 Jun 2018 00:40:13 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1187
x-ms-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9
x-ms-correlation-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9
{
  "value": [
    {
      "activityRunEnd": "2018-06-16T00:38:11.5445431Z",
      "activityName": "ExampleForeachActivity",
      "activityRunStart": "2018-06-16T00:37:49.4804925Z",
      "activityType": "ForEach",
      "durationInMs": 22064,
      "retryAttempt": null,
      "error": {
        "errorCode": "",
        "message": "",
        "failureType": "",
        "target": "ExampleForeachActivity"
      },
      "activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680",
      "input": {},
      "linkedServiceName": "",
      "output": {},
      "userProperties": {},
      "pipelineName": "examplePipeline",
      "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "status": "Succeeded"
    },
    {
      "activityRunEnd": "2018-06-16T00:38:07.4188923Z",
      "activityName": "ExampleCopyActivity",
      "activityRunStart": "2018-06-16T00:37:50.2460952Z",
      "activityType": "Copy",
      "durationInMs": 17172,
      "retryAttempt": null,
      "error": {
        "errorCode": "",
        "message": "",
        "failureType": "",
        "target": "ExampleCopyActivity"
      },
      "activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51",
      "input": {
        "source": {
          "type": "BlobSource"
        },
        "sink": {
          "type": "BlobSink"
        },
        "dataIntegrationUnits": 32
      },
      "linkedServiceName": "",
      "output": {
        "dataRead": 142000,
        "dataWritten": 142000,
        "filesRead": 1,
        "filesWritten": 1,
        "copyDuration": 6,
        "throughput": 23.112,
        "errors": [],
        "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)",
        "usedCloudDataMovementUnits": 4,
        "usedParallelCopies": 1,
        "executionDetails": [
          {
            "source": {
              "type": "AzureBlob"
            },
            "sink": {
              "type": "AzureBlob"
            },
            "status": "Succeeded",
            "start": "2018-06-16T00:37:50.68834Z",
            "duration": 6,
            "usedCloudDataMovementUnits": 4,
            "usedParallelCopies": 1,
            "detailedDurations": {
              "queuingDuration": 4,
              "transferDuration": 2
            }
          }
        ]
      },
      "userProperties": {},
      "pipelineName": "examplePipeline",
      "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "status": "Succeeded"
    }
  ]
}

定义

名称 说明
ActivityRun

有关在管道中运行的活动的信息。
ActivityRunsQueryResponse

列表活动运行。
CloudError

定义Azure 数据工厂错误响应结构的对象。
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。

ActivityRun

有关在管道中运行的活动的信息。

名称 类型 说明
activityName

string

活动的名称。
activityRunEnd

string

活动的结束时间以“ISO 8601”格式运行。
activityRunId

string

活动运行的 ID。
activityRunStart

string

活动的开始时间以“ISO 8601”格式运行。
activityType

string

活动的类型。
durationInMs

integer

活动运行的持续时间。
error

object

如果活动有任何运行错误，则为错误。
input

object

活动的输入。
linkedServiceName

string

计算链接服务的名称。
output

object

活动的输出。
pipelineName

string

管道的名称。
pipelineRunId

string

管道运行的 ID。
status

string

活动运行的状态。

ActivityRunsQueryResponse

列表活动运行。

名称 类型 说明
continuationToken

string

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

ActivityRun[]

活动运行列表。

CloudError

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

名称 类型 说明
error.code

string

错误代码。
error.details

CloudError[]

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

string

错误消息。
error.target

string

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

RunFilterParameters

用于列出运行的查询参数。

名称 类型 说明
continuationToken

string

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

RunQueryFilter[]

筛选器列表。
lastUpdatedAfter

string

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

string

以“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。

名称 类型 说明
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

ActivityType

string

LatestOnly

string

PipelineName

string

RunEnd

string

RunGroupId

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string

RunQueryFilterOperator

要用于筛选的运算符。

名称 类型 说明
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

参数的排序顺序。

名称 类型 说明
ASC

string

DESC

string

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。

名称 类型 说明
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string