Activity Runs - Query By Pipeline Run
A lekérdezési tevékenység a bemeneti szűrőfeltételek alapján fut.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
factory
|
path | True |
string |
A gyár neve. Regex pattern: |
resource
|
path | True |
string |
Az erőforráscsoport neve. Regex pattern: |
run
|
path | True |
string |
A folyamatfuttatás azonosítója. |
subscription
|
path | True |
string |
Az előfizetés azonosítója. |
api-version
|
query | True |
string |
Az API-verzió. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
lastUpdatedAfter | True |
string |
A futtatási esemény "ISO 8601" formátumban történő frissítésének időpontja vagy azt követően. |
lastUpdatedBefore | True |
string |
A futtatási esemény "ISO 8601" formátumban történő frissítésének időpontja vagy előtt. |
continuationToken |
string |
A folytatási jogkivonat az eredmények következő oldalának lekéréséhez. Null érték az első oldalhoz. |
|
filters |
Szűrők listája. |
||
orderBy |
Az OrderBy beállítás listája. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK gombra. |
|
Other Status Codes |
Hibaválasz érkezett a Azure Data Factory szolgáltatástól. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
ActivityRuns_QueryByPipelineRun
Sample Request
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"
}
Sample Response
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"
}
]
}
Definíciók
Name | Description |
---|---|
Activity |
A folyamatban futtatott tevékenységre vonatkozó információk. |
Activity |
Egy listatevékenység fut. |
Cloud |
A Azure Data Factory hibaválasz struktúráját meghatározó objektum. |
Run |
A listázási futtatások lekérdezési paraméterei. |
Run |
Lekérdezésszűrő beállítás listázási futtatásokhoz. |
Run |
A szűrőhöz használandó paraméternév. A folyamatfuttatások lekérdezéséhez engedélyezett operandusok a Következők: PipelineName, RunStart, RunEnd és Status; a lekérdezési tevékenységfuttatások a következők: ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType és Status, valamint a lekérdezési eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status. |
Run |
A szűrőhöz használandó operátor. |
Run |
A paraméter rendezési sorrendje. |
Run |
Egy objektum, amely a futtatások listázásának beállításai alapján adja meg a sorrendet. |
Run |
A rendeléshez használandó paraméternév. A folyamatfuttatások számára engedélyezett paraméterek a következők: PipelineName, RunStart, RunEnd és Status; tevékenységfuttatások esetén: ActivityName, ActivityRunStart, ActivityRunEnd és Status; eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status. |
ActivityRun
A folyamatban futtatott tevékenységre vonatkozó információk.
Name | Típus | Description |
---|---|---|
activityName |
string |
A tevékenység neve. |
activityRunEnd |
string |
A tevékenység befejezési ideje "ISO 8601" formátumban fut. |
activityRunId |
string |
A tevékenységfuttatás azonosítója. |
activityRunStart |
string |
A tevékenység kezdési időpontja "ISO 8601" formátumban fut. |
activityType |
string |
A tevékenység típusa. |
durationInMs |
integer |
A tevékenységfuttatás időtartama. |
error |
object |
A hiba, ha a tevékenység fut. |
input |
object |
A tevékenység bemenete. |
linkedServiceName |
string |
A számítási társított szolgáltatás neve. |
output |
object |
A tevékenység kimenete. |
pipelineName |
string |
A folyamat neve. |
pipelineRunId |
string |
A folyamatfuttatás azonosítója. |
status |
string |
A tevékenységfuttatás állapota. |
ActivityRunsQueryResponse
Egy listatevékenység fut.
Name | Típus | Description |
---|---|---|
continuationToken |
string |
A folytatási jogkivonat az eredmények következő oldalának lekéréséhez, ha vannak még eredmények, null értékű. |
value |
A tevékenységfuttatások listája. |
CloudError
A Azure Data Factory hibaválasz struktúráját meghatározó objektum.
Name | Típus | Description |
---|---|---|
error.code |
string |
Hibakód. |
error.details |
Tömb további hiba részleteivel. |
|
error.message |
string |
Hibaüzenet. |
error.target |
string |
A kérelemben szereplő tulajdonságnév/elérési út hiba miatt van társítva. |
RunFilterParameters
A listázási futtatások lekérdezési paraméterei.
Name | Típus | Description |
---|---|---|
continuationToken |
string |
A folytatási jogkivonat az eredmények következő oldalának lekéréséhez. Null érték az első oldalhoz. |
filters |
Szűrők listája. |
|
lastUpdatedAfter |
string |
A futtatási esemény "ISO 8601" formátumban történő frissítésének időpontja vagy azt követően. |
lastUpdatedBefore |
string |
A futtatási esemény "ISO 8601" formátumban történő frissítésének időpontja vagy előtt. |
orderBy |
Az OrderBy beállítás listája. |
RunQueryFilter
Lekérdezésszűrő beállítás listázási futtatásokhoz.
Name | Típus | Description |
---|---|---|
operand |
A szűrőhöz használandó paraméternév. A folyamatfuttatások lekérdezéséhez engedélyezett operandusok a Következők: PipelineName, RunStart, RunEnd és Status; a lekérdezési tevékenységfuttatások a következők: ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType és Status, valamint a lekérdezési eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status. |
|
operator |
A szűrőhöz használandó operátor. |
|
values |
string[] |
Szűrőértékek listája. |
RunQueryFilterOperand
A szűrőhöz használandó paraméternév. A folyamatfuttatások lekérdezéséhez engedélyezett operandusok a Következők: PipelineName, RunStart, RunEnd és Status; a lekérdezési tevékenységfuttatások a következők: ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType és Status, valamint a lekérdezési eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status.
Name | Típus | 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
A szűrőhöz használandó operátor.
Name | Típus | Description |
---|---|---|
Equals |
string |
|
In |
string |
|
NotEquals |
string |
|
NotIn |
string |
RunQueryOrder
A paraméter rendezési sorrendje.
Name | Típus | Description |
---|---|---|
ASC |
string |
|
DESC |
string |
RunQueryOrderBy
Egy objektum, amely a futtatások listázásának beállításai alapján adja meg a sorrendet.
Name | Típus | Description |
---|---|---|
order |
A paraméter rendezési sorrendje. |
|
orderBy |
A rendeléshez használandó paraméternév. A folyamatfuttatások számára engedélyezett paraméterek a következők: PipelineName, RunStart, RunEnd és Status; tevékenységfuttatások esetén: ActivityName, ActivityRunStart, ActivityRunEnd és Status; eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status. |
RunQueryOrderByField
A rendeléshez használandó paraméternév. A folyamatfuttatások számára engedélyezett paraméterek a következők: PipelineName, RunStart, RunEnd és Status; tevékenységfuttatások esetén: ActivityName, ActivityRunStart, ActivityRunEnd és Status; eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status.
Name | Típus | Description |
---|---|---|
ActivityName |
string |
|
ActivityRunEnd |
string |
|
ActivityRunStart |
string |
|
PipelineName |
string |
|
RunEnd |
string |
|
RunStart |
string |
|
Status |
string |
|
TriggerName |
string |
|
TriggerRunTimestamp |
string |