Activity Runs - Query By Pipeline Run
Działanie zapytania jest uruchamiane na podstawie warunków filtrowania wejściowego.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
factory
|
path | True |
string |
Nazwa fabryki. Wzorzec wyrażenia regularnego: |
resource
|
path | True |
string |
Nazwa grupy zasobów. Wzorzec wyrażenia regularnego: |
run
|
path | True |
string |
Identyfikator uruchomienia potoku. |
subscription
|
path | True |
string |
Identyfikator subskrypcji. |
api-version
|
query | True |
string |
Wersja interfejsu API. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
lastUpdatedAfter | True |
string |
Czas, w którym zdarzenie uruchomienia zostało zaktualizowane w formacie "ISO 8601". |
lastUpdatedBefore | True |
string |
Czas, w którym zdarzenie uruchomienia zostało zaktualizowane w formacie ISO 8601 lub przed nim. |
continuationToken |
string |
Token kontynuacji umożliwiający uzyskanie następnej strony wyników. Wartość null dla pierwszej strony. |
|
filters |
Lista filtrów. |
||
orderBy |
Lista opcji OrderBy. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Odpowiedź o błędzie odebrana z usługi Azure Data Factory. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
ActivityRuns_QueryByPipelineRun
Przykładowe żądanie
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"
}
Przykładowa odpowiedź
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"
}
]
}
Definicje
Nazwa | Opis |
---|---|
Activity |
Informacje o uruchomieniu działania w potoku. |
Activity |
Zostanie uruchomione działanie listy. |
Cloud |
Obiekt, który definiuje strukturę odpowiedzi Azure Data Factory błędu. |
Run |
Parametry zapytania dotyczące uruchamiania listy. |
Run |
Opcja filtru zapytania dla przebiegów listy. |
Run |
Nazwa parametru, która ma być używana do filtrowania. Dozwolone operandy do wykonywania zapytań potoków to PipelineName, RunStart, RunEnd i Status; do uruchamiania działań zapytań to ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType i Status, a do uruchamiania wyzwalacza zapytania są TriggerName, TriggerRunTimestamp i Status. |
Run |
Operator, który ma być używany do filtrowania. |
Run |
Kolejność sortowania parametru. |
Run |
Obiekt zapewniający kolejność według opcji uruchamiania listy. |
Run |
Nazwa parametru, która ma być używana do zamówienia według. Dozwolone parametry do zamówienia według dla przebiegów potoków to PipelineName, RunStart, RunEnd i Status; dla przebiegów działań to ActivityName, ActivityRunStart, ActivityRunEnd i Status; dla przebiegów wyzwalacza to TriggerName, TriggerRunTimestamp i Status. |
ActivityRun
Informacje o uruchomieniu działania w potoku.
Nazwa | Typ | Opis |
---|---|---|
activityName |
string |
Nazwa działania. |
activityRunEnd |
string |
Godzina zakończenia działania jest uruchamiana w formacie "ISO 8601". |
activityRunId |
string |
Identyfikator przebiegu działania. |
activityRunStart |
string |
Godzina rozpoczęcia działania uruchomionego w formacie "ISO 8601". |
activityType |
string |
Typ działania. |
durationInMs |
integer |
Czas trwania przebiegu działania. |
error |
object |
Błąd, jeśli którykolwiek z uruchomienia działania. |
input |
object |
Dane wejściowe działania. |
linkedServiceName |
string |
Nazwa połączonej usługi obliczeniowej. |
output |
object |
Dane wyjściowe działania. |
pipelineName |
string |
Nazwa potoku. |
pipelineRunId |
string |
Identyfikator przebiegu potoku. |
status |
string |
Stan przebiegu działania. |
ActivityRunsQueryResponse
Zostanie uruchomione działanie listy.
Nazwa | Typ | Opis |
---|---|---|
continuationToken |
string |
Token kontynuacji pobierania następnej strony wyników, jeśli jakiekolwiek pozostałe wyniki istnieją, w przeciwnym razie wartość null. |
value |
Lista przebiegów działań. |
CloudError
Obiekt, który definiuje strukturę odpowiedzi Azure Data Factory błędu.
Nazwa | Typ | Opis |
---|---|---|
error.code |
string |
Kod błędu. |
error.details |
Tablica z dodatkowymi szczegółami błędu. |
|
error.message |
string |
Komunikat o błędzie. |
error.target |
string |
Nazwa/ścieżka właściwości w żądaniu skojarzonym z błędem. |
RunFilterParameters
Parametry zapytania dotyczące uruchamiania listy.
Nazwa | Typ | Opis |
---|---|---|
continuationToken |
string |
Token kontynuacji umożliwiający uzyskanie następnej strony wyników. Wartość null dla pierwszej strony. |
filters |
Lista filtrów. |
|
lastUpdatedAfter |
string |
Czas, w którym zdarzenie uruchomienia zostało zaktualizowane w formacie "ISO 8601". |
lastUpdatedBefore |
string |
Czas, w którym zdarzenie uruchomienia zostało zaktualizowane w formacie ISO 8601 lub przed nim. |
orderBy |
Lista opcji OrderBy. |
RunQueryFilter
Opcja filtru zapytania dla przebiegów listy.
Nazwa | Typ | Opis |
---|---|---|
operand |
Nazwa parametru, która ma być używana do filtrowania. Dozwolone operandy do wykonywania zapytań potoków to PipelineName, RunStart, RunEnd i Status; do uruchamiania działań zapytań to ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType i Status, a do uruchamiania wyzwalacza zapytania są TriggerName, TriggerRunTimestamp i Status. |
|
operator |
Operator, który ma być używany do filtrowania. |
|
values |
string[] |
Lista wartości filtru. |
RunQueryFilterOperand
Nazwa parametru, która ma być używana do filtrowania. Dozwolone operandy do wykonywania zapytań potoków to PipelineName, RunStart, RunEnd i Status; do uruchamiania działań zapytań to ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType i Status, a do uruchamiania wyzwalacza zapytania są TriggerName, TriggerRunTimestamp i Status.
Nazwa | Typ | Opis |
---|---|---|
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
Operator, który ma być używany do filtrowania.
Nazwa | Typ | Opis |
---|---|---|
Equals |
string |
|
In |
string |
|
NotEquals |
string |
|
NotIn |
string |
RunQueryOrder
Kolejność sortowania parametru.
Nazwa | Typ | Opis |
---|---|---|
ASC |
string |
|
DESC |
string |
RunQueryOrderBy
Obiekt zapewniający kolejność według opcji uruchamiania listy.
Nazwa | Typ | Opis |
---|---|---|
order |
Kolejność sortowania parametru. |
|
orderBy |
Nazwa parametru, która ma być używana do zamówienia według. Dozwolone parametry do zamówienia według dla przebiegów potoków to PipelineName, RunStart, RunEnd i Status; dla przebiegów działań to ActivityName, ActivityRunStart, ActivityRunEnd i Status; dla przebiegów wyzwalacza to TriggerName, TriggerRunTimestamp i Status. |
RunQueryOrderByField
Nazwa parametru, która ma być używana do zamówienia według. Dozwolone parametry do zamówienia według dla przebiegów potoków to PipelineName, RunStart, RunEnd i Status; dla przebiegów działań to ActivityName, ActivityRunStart, ActivityRunEnd i Status; dla przebiegów wyzwalacza to TriggerName, TriggerRunTimestamp i Status.
Nazwa | Typ | Opis |
---|---|---|
ActivityName |
string |
|
ActivityRunEnd |
string |
|
ActivityRunStart |
string |
|
PipelineName |
string |
|
RunEnd |
string |
|
RunStart |
string |
|
Status |
string |
|
TriggerName |
string |
|
TriggerRunTimestamp |
string |