Activity Runs - Query By Pipeline Run
查詢活動會根據輸入篩選條件執行。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
factory
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
Factory 名稱。 |
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
資源組名。 |
run
|
path | True |
string |
管線執行標識碼。 |
subscription
|
path | True |
string |
訂用帳戶標識碼。 |
api-version
|
query | True |
string |
API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
lastUpdatedAfter | True |
string (date-time) |
執行事件以 『ISO 8601』 格式更新的時間或之後。 |
lastUpdatedBefore | True |
string (date-time) |
執行事件在 『ISO 8601』 格式更新之前的時間。 |
continuationToken |
string |
取得下一頁結果的接續令牌。 第一頁的 Null。 |
|
filters |
篩選清單。 |
||
orderBy |
OrderBy 選項的清單。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行。 |
|
Other Status Codes |
從 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"
}
範例回覆
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 |
---|---|
Activity |
管線中執行活動的相關信息。 |
Activity |
清單活動會執行。 |
Cloud |
對象,定義 Azure Data Factory 錯誤響應的結構。 |
Run |
清單執行的查詢參數。 |
Run |
清單執行的查詢篩選選項。 |
Run |
要用於篩選的參數名稱。 查詢管線執行的允許作數為 PipelineName、RunStart、RunEnd 和 Status;若要查詢活動執行,則為 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,而查詢觸發程式執行則為 TriggerName、TriggerRunTimestamp 和 Status。 |
Run |
要用於篩選的運算子。 |
Run |
參數的排序順序。 |
Run |
要依清單執行選項提供順序的物件。 |
Run |
要用於排序依據的參數名稱。 管線執行的允許參數為 PipelineName、RunStart、RunEnd 和 Status;針對活動執行為 ActivityName、ActivityRunStart、ActivityRunEnd 和 Status;若為觸發程式執行,則為 TriggerName、TriggerRunTimestamp 和 Status。 |
ActivityRun
管線中執行活動的相關信息。
名稱 | 類型 | Description |
---|---|---|
activityName |
string |
活動的名稱。 |
activityRunEnd |
string (date-time) |
活動的結束時間會以 『ISO 8601』 格式執行。 |
activityRunId |
string |
活動執行的標識碼。 |
activityRunStart |
string (date-time) |
活動的開始時間會以 『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 |
活動執行清單。 |
CloudError
對象,定義 Azure Data Factory 錯誤響應的結構。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
錯誤碼。 |
error.details |
具有其他錯誤詳細數據的陣列。 |
|
error.message |
string |
錯誤資訊。 |
error.target |
string |
與錯誤相關聯之要求中的屬性名稱/路徑。 |
RunFilterParameters
清單執行的查詢參數。
名稱 | 類型 | Description |
---|---|---|
continuationToken |
string |
取得下一頁結果的接續令牌。 第一頁的 Null。 |
filters |
篩選清單。 |
|
lastUpdatedAfter |
string (date-time) |
執行事件以 『ISO 8601』 格式更新的時間或之後。 |
lastUpdatedBefore |
string (date-time) |
執行事件在 『ISO 8601』 格式更新之前的時間。 |
orderBy |
OrderBy 選項的清單。 |
RunQueryFilter
清單執行的查詢篩選選項。
名稱 | 類型 | Description |
---|---|---|
operand |
要用於篩選的參數名稱。 查詢管線執行的允許作數為 PipelineName、RunStart、RunEnd 和 Status;若要查詢活動執行,則為 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,而查詢觸發程式執行則為 TriggerName、TriggerRunTimestamp 和 Status。 |
|
operator |
要用於篩選的運算子。 |
|
values |
string[] |
篩選值的清單。 |
RunQueryFilterOperand
要用於篩選的參數名稱。 查詢管線執行的允許作數為 PipelineName、RunStart、RunEnd 和 Status;若要查詢活動執行,則為 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,而查詢觸發程式執行則為 TriggerName、TriggerRunTimestamp 和 Status。
值 | Description |
---|---|
ActivityName | |
ActivityRunEnd | |
ActivityRunStart | |
ActivityType | |
LatestOnly | |
PipelineName | |
RunEnd | |
RunGroupId | |
RunStart | |
Status | |
TriggerName | |
TriggerRunTimestamp |
RunQueryFilterOperator
要用於篩選的運算子。
值 | Description |
---|---|
Equals | |
In | |
NotEquals | |
NotIn |
RunQueryOrder
參數的排序順序。
值 | Description |
---|---|
ASC | |
DESC |
RunQueryOrderBy
要依清單執行選項提供順序的物件。
名稱 | 類型 | Description |
---|---|---|
order |
參數的排序順序。 |
|
orderBy |
要用於排序依據的參數名稱。 管線執行的允許參數為 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 | |
ActivityRunEnd | |
ActivityRunStart | |
PipelineName | |
RunEnd | |
RunStart | |
Status | |
TriggerName | |
TriggerRunTimestamp |