共用方式為

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 參數

名稱 位於 必要 類型 Description
factoryName
 path True

string

Factory 名稱。

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

string

資源群組名稱。

Regex 模式: ^[-\w\._\(\)]+$
runId
 path True

string

管線執行標識碼。
subscriptionId
 path True

string

訂用帳戶識別碼。
api-version
 query True

string

API 版本。

要求本文

名稱 必要 類型 Description
lastUpdatedAfter True

string

在 或 之後，執行事件會以 'ISO 8601' 格式更新的時間。
lastUpdatedBefore True

string

執行事件在 『ISO 8601』 格式更新之前的時間。
continuationToken

string

取得下一頁結果的接續令牌。 第一頁的 Null。
filters

RunQueryFilter[]

篩選清單。
orderBy

RunQueryOrderBy[]

OrderBy 選項的清單。

回應

名稱 類型 Description
200 OK

ActivityRunsQueryResponse

正常。
Other Status Codes

CloudError

從 Azure Data Factory 服務收到的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
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"
    }
  ]
}

定義

名稱 Description
ActivityRun

管線中活動執行的相關信息。
ActivityRunsQueryResponse

清單活動執行。
CloudError

對象，定義 Azure Data Factory 錯誤響應的結構。
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

管線中活動執行的相關信息。

名稱 類型 Description
activityName

string

活動名稱。
activityRunEnd

string

活動的結束時間會以 『ISO 8601』 格式執行。
activityRunId

string

活動執行的標識碼。
activityRunStart

string

活動的開始時間會以 『ISO 8601』 格式執行。
activityType

string

活動的類型。
durationInMs

integer

活動執行的持續時間。
error

object

如果活動有任何執行，則為錯誤。
input

object

活動的輸入。
linkedServiceName

string

計算連結服務的名稱。
output

object

活動的輸出。
pipelineName

string

管線名稱。
pipelineRunId

string

管線執行的標識碼。
status

string

活動執行的狀態。

ActivityRunsQueryResponse

清單活動執行。

名稱 類型 Description
continuationToken

string

如果有任何剩餘的結果存在，則為取得下一頁結果的接續令牌，否則為 null。
value

ActivityRun[]

活動執行的清單。

CloudError

對象，定義 Azure Data Factory 錯誤響應的結構。

名稱 類型 Description
error.code

string

錯誤碼。
error.details

CloudError[]

具有其他錯誤詳細數據的陣列。
error.message

string

錯誤訊息。
error.target

string

與錯誤相關聯的要求中的屬性名稱/路徑。

RunFilterParameters

清單執行的查詢參數。

名稱 類型 Description
continuationToken

string

取得下一頁結果的接續令牌。 第一頁的 Null。
filters

RunQueryFilter[]

篩選清單。
lastUpdatedAfter

string

在 或 之後，執行事件會以 'ISO 8601' 格式更新的時間。
lastUpdatedBefore

string

執行事件在 『ISO 8601』 格式更新之前的時間。
orderBy

RunQueryOrderBy[]

OrderBy 選項的清單。

RunQueryFilter

清單執行的查詢篩選選項。

名稱 類型 Description
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。

名稱 類型 Description
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

要用於篩選的運算子。

名稱 類型 Description
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

參數的排序順序。

名稱 類型 Description
ASC

string

DESC

string

RunQueryOrderBy

要依清單執行選項提供順序的物件。

名稱 類型 Description
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。

名稱 類型 Description
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string