Activity Runs - Query By Pipeline Run
Działanie zapytania jest uruchamiane na podstawie warunków filtrowania danych wejściowych.
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 minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
Nazwa fabryki. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
Nazwa grupy zasobów. |
|
run
|
path | True |
string |
Identyfikator przebiegu potoku. |
|
subscription
|
path | True |
string |
Identyfikator subskrypcji. |
|
api-version
|
query | True |
string |
Wersja interfejsu API. |
Treść żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| lastUpdatedAfter | True |
string (date-time) |
Czas aktualizacji zdarzenia uruchomienia w formacie ISO 8601 lub później. |
| lastUpdatedBefore | True |
string (date-time) |
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 |
Odebrano odpowiedź o błędzie z usługi Azure Data Factory. |
Zabezpieczenia
azure_auth
Przepływ protokołu OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresów
| Nazwa | Opis |
|---|---|
| user_impersonation | personifikacja konta użytkownika |
Przykłady
ActivityRuns_QueryByPipelineRun
Przykładowe zapytanie
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 |
Działanie listy jest uruchamiane. |
|
Cloud |
Obiekt, który definiuje strukturę odpowiedzi błędu usługi Azure Data Factory. |
|
Run |
Parametry zapytania dotyczące wyświetlania listy przebiegów. |
|
Run |
Opcja filtru zapytania dla przebiegów listy. |
|
Run |
Nazwa parametru, która ma być używana do filtrowania. Dozwolone operandy do wykonywania zapytań w potokach 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 wyświetlania listy przebiegów. |
|
Run |
Nazwa parametru, która ma być używana dla kolejności. Dozwolone parametry do zamówienia 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 (date-time) |
Godzina zakończenia działania jest uruchamiana w formacie ISO 8601. |
| activityRunId |
string |
Identyfikator przebiegu działania. |
| activityRunStart |
string (date-time) |
Godzina rozpoczęcia działania jest uruchamiana w formacie ISO 8601. |
| activityType |
string |
Typ działania. |
| durationInMs |
integer |
Czas trwania przebiegu działania. |
| error |
object |
Błąd, jeśli istnieje 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 uruchomienia działania. |
ActivityRunsQueryResponse
Działanie listy jest uruchamiane.
| Nazwa | Typ | Opis |
|---|---|---|
| continuationToken |
string |
Token kontynuacji umożliwiający uzyskanie następnej strony wyników, jeśli istnieją pozostałe wyniki, wartość null w przeciwnym razie. |
| value |
Lista uruchomień działań. |
CloudError
Obiekt, który definiuje strukturę odpowiedzi błędu usługi Azure Data Factory.
| 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 wyświetlania listy przebiegów.
| 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 (date-time) |
Czas aktualizacji zdarzenia uruchomienia w formacie ISO 8601 lub później. |
| lastUpdatedBefore |
string (date-time) |
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ń w potokach 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ń w potokach 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.
| Wartość | Opis |
|---|---|
| PipelineName | |
| Status | |
| RunStart | |
| RunEnd | |
| ActivityName | |
| ActivityRunStart | |
| ActivityRunEnd | |
| ActivityType | |
| TriggerName | |
| TriggerRunTimestamp | |
| RunGroupId | |
| LatestOnly |
RunQueryFilterOperator
Operator, który ma być używany do filtrowania.
| Wartość | Opis |
|---|---|
| Equals | |
| NotEquals | |
| In | |
| NotIn |
RunQueryOrder
Kolejność sortowania parametru.
| Wartość | Opis |
|---|---|
| ASC | |
| DESC |
RunQueryOrderBy
Obiekt zapewniający kolejność według opcji wyświetlania listy przebiegów.
| Nazwa | Typ | Opis |
|---|---|---|
| order |
Kolejność sortowania parametru. |
|
| orderBy |
Nazwa parametru, która ma być używana dla kolejności. Dozwolone parametry do zamówienia 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 dla kolejności. Dozwolone parametry do zamówienia 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.
| Wartość | Opis |
|---|---|
| RunStart | |
| RunEnd | |
| PipelineName | |
| Status | |
| ActivityName | |
| ActivityRunStart | |
| ActivityRunEnd | |
| TriggerName | |
| TriggerRunTimestamp |