Activity Runs - Query By Pipeline Run
Abfrageaktivität wird basierend auf Eingabefilterbedingungen ausgeführt.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
factory
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
run
|
path | True |
string |
Der Pipelineausführungsbezeichner. |
|
subscription
|
path | True |
string (uuid) |
Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| lastUpdatedAfter | True |
string (date-time) |
Die Uhrzeit, zu der bzw. nach der das Ausführungsereignis im ISO 8601-Format aktualisiert wurde. |
| lastUpdatedBefore | True |
string (date-time) |
Die Uhrzeit, zu der bzw. vor der das Ausführungsereignis im ISO 8601-Format aktualisiert wurde. |
| continuationToken |
string |
Das Fortsetzungstoken zum Abrufen der nächsten Seite mit Ergebnissen. Null für die erste Seite. |
|
| filters |
Liste der Filter. |
||
| orderBy |
Liste der Option "OrderBy". |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Azure-Operation erfolgreich abgeschlossen. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
ActivityRuns_QueryByPipelineRun
Beispielanforderung
POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/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"
}
Beispiel für eine Antwort
Date: Sat, 16 Jun 2018 00:40:13 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9
x-ms-ratelimit-remaining-subscription-writes: 1187
x-ms-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9
{
"value": [
{
"activityName": "ExampleForeachActivity",
"activityRunEnd": "2018-06-16T00:38:11.5445431Z",
"activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680",
"activityRunStart": "2018-06-16T00:37:49.4804925Z",
"activityType": "ForEach",
"durationInMs": 22064,
"error": {
"errorCode": "",
"failureType": "",
"message": "",
"target": "ExampleForeachActivity"
},
"input": {},
"linkedServiceName": "",
"output": {},
"pipelineName": "examplePipeline",
"pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
"retryAttempt": null,
"status": "Succeeded",
"userProperties": {}
},
{
"activityName": "ExampleCopyActivity",
"activityRunEnd": "2018-06-16T00:38:07.4188923Z",
"activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51",
"activityRunStart": "2018-06-16T00:37:50.2460952Z",
"activityType": "Copy",
"durationInMs": 17172,
"error": {
"errorCode": "",
"failureType": "",
"message": "",
"target": "ExampleCopyActivity"
},
"input": {
"dataIntegrationUnits": 32,
"sink": {
"type": "BlobSink"
},
"source": {
"type": "BlobSource"
}
},
"linkedServiceName": "",
"output": {
"copyDuration": 6,
"dataRead": 142000,
"dataWritten": 142000,
"effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)",
"errors": [],
"executionDetails": [
{
"detailedDurations": {
"queuingDuration": 4,
"transferDuration": 2
},
"duration": 6,
"sink": {
"type": "AzureBlob"
},
"source": {
"type": "AzureBlob"
},
"start": "2018-06-16T00:37:50.68834Z",
"status": "Succeeded",
"usedCloudDataMovementUnits": 4,
"usedParallelCopies": 1
}
],
"filesRead": 1,
"filesWritten": 1,
"throughput": 23.112,
"usedCloudDataMovementUnits": 4,
"usedParallelCopies": 1
},
"pipelineName": "examplePipeline",
"pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
"retryAttempt": null,
"status": "Succeeded",
"userProperties": {}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Activity |
Informationen zu einer Aktivität, die in einer Pipeline ausgeführt wird. |
|
Activity |
Eine Listenaktivität wird ausgeführt. |
|
Cloud |
Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert. |
|
Run |
Abfrageparameter für auflistungsausführungen. |
|
Run |
Abfragefilteroption für Die Auflistung wird ausgeführt. |
|
Run |
Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden für die Abfragepipeline sind PipelineName, RunStart, RunEnd und Status; zur Abfrageaktivitätsausführung sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status sowie abfragetriggerausführungen Triggername, TriggerRunTimestamp und Status. |
|
Run |
Operator, der für den Filter verwendet werden soll. |
|
Run |
Sortierreihenfolge des Parameters. |
|
Run |
Ein Objekt, das die Reihenfolge nach Optionen zum Auflisten von Ausführungsläufen bereitstellt. |
|
Run |
Parametername, der für die Reihenfolge verwendet werden soll. Die zulässigen Parameter für pipelineausführungen sind PipelineName, RunStart, RunEnd und Status; für Aktivitätsläufe sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerläufe sind TriggerName, TriggerRunTimestamp und Status. |
ActivityRun
Informationen zu einer Aktivität, die in einer Pipeline ausgeführt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| activityName |
string |
Der Name der Aktivität. |
| activityRunEnd |
string (date-time) |
Die Endzeit der Aktivität, die im ISO 8601-Format ausgeführt wird. |
| activityRunId |
string |
Die ID der Aktivitätsausführung. |
| activityRunStart |
string (date-time) |
Die Startzeit der Aktivität im ISO 8601-Format. |
| activityType |
string |
Der Typ der Aktivität. |
| durationInMs |
integer (int32) |
Die Dauer der Ausführung der Aktivität. |
| error |
Der Fehler, wenn eine der Aktivitäten ausgeführt wird. |
|
| input |
Die Eingabe für die Aktivität. |
|
| linkedServiceName |
string |
Der Name des compute-verknüpften Diensts. |
| output |
Die Ausgabe für die Aktivität. |
|
| pipelineName |
string |
Der Name der Pipeline. |
| pipelineRunId |
string |
Die ID der Pipelineausführung. |
| status |
string |
Der Status der Aktivitätsausführung. |
ActivityRunsQueryResponse
Eine Listenaktivität wird ausgeführt.
| Name | Typ | Beschreibung |
|---|---|---|
| continuationToken |
string |
Das Fortsetzungstoken zum Abrufen der nächsten Seite mit Ergebnissen, wenn verbleibende Ergebnisse vorhanden sind, andernfalls NULL. |
| value |
Liste der Aktivitätsausführungen. |
CloudError
Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.
| Name | Typ | Beschreibung |
|---|---|---|
| error.code |
string |
Fehlercode. |
| error.details |
Array mit zusätzlichen Fehlerdetails. |
|
| error.message |
string |
Fehlermeldung. |
| error.target |
string |
Eigenschaftsname/Pfad in Anforderung, die fehler zugeordnet ist. |
RunFilterParameters
Abfrageparameter für auflistungsausführungen.
| Name | Typ | Beschreibung |
|---|---|---|
| continuationToken |
string |
Das Fortsetzungstoken zum Abrufen der nächsten Seite mit Ergebnissen. Null für die erste Seite. |
| filters |
Liste der Filter. |
|
| lastUpdatedAfter |
string (date-time) |
Die Uhrzeit, zu der bzw. nach der das Ausführungsereignis im ISO 8601-Format aktualisiert wurde. |
| lastUpdatedBefore |
string (date-time) |
Die Uhrzeit, zu der bzw. vor der das Ausführungsereignis im ISO 8601-Format aktualisiert wurde. |
| orderBy |
Liste der Option "OrderBy". |
RunQueryFilter
Abfragefilteroption für Die Auflistung wird ausgeführt.
| Name | Typ | Beschreibung |
|---|---|---|
| operand |
Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden für die Abfragepipeline sind PipelineName, RunStart, RunEnd und Status; zur Abfrageaktivitätsausführung sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status sowie abfragetriggerausführungen Triggername, TriggerRunTimestamp und Status. |
|
| operator |
Operator, der für den Filter verwendet werden soll. |
|
| values |
string[] |
Liste der Filterwerte. |
RunQueryFilterOperand
Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden für die Abfragepipeline sind PipelineName, RunStart, RunEnd und Status; zur Abfrageaktivitätsausführung sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status sowie abfragetriggerausführungen Triggername, TriggerRunTimestamp und Status.
| Wert | Beschreibung |
|---|---|
| PipelineName |
PipelineName |
| Status |
Status |
| RunStart |
RunStart |
| RunEnd |
RunEnd |
| ActivityName |
Aktivitätsname |
| ActivityRunStart |
ActivityRunStart |
| ActivityRunEnd |
ActivityRunEnd |
| ActivityType |
Aktivitätstyp |
| TriggerName |
Auslösername |
| TriggerRunTimestamp |
TriggerRunTimestamp |
| RunGroupId |
RunGroupId |
| LatestOnly |
LatestOnly |
RunQueryFilterOperator
Operator, der für den Filter verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| Equals |
Ist gleich |
| NotEquals |
NotEquals |
| In |
In |
| NotIn |
NotIn |
RunQueryOrder
Sortierreihenfolge des Parameters.
| Wert | Beschreibung |
|---|---|
| ASC |
ASC |
| DESC |
DESC |
RunQueryOrderBy
Ein Objekt, das die Reihenfolge nach Optionen zum Auflisten von Ausführungsläufen bereitstellt.
| Name | Typ | Beschreibung |
|---|---|---|
| order |
Sortierreihenfolge des Parameters. |
|
| orderBy |
Parametername, der für die Reihenfolge verwendet werden soll. Die zulässigen Parameter für pipelineausführungen sind PipelineName, RunStart, RunEnd und Status; für Aktivitätsläufe sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerläufe sind TriggerName, TriggerRunTimestamp und Status. |
RunQueryOrderByField
Parametername, der für die Reihenfolge verwendet werden soll. Die zulässigen Parameter für pipelineausführungen sind PipelineName, RunStart, RunEnd und Status; für Aktivitätsläufe sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerläufe sind TriggerName, TriggerRunTimestamp und Status.
| Wert | Beschreibung |
|---|---|
| RunStart |
RunStart |
| RunEnd |
RunEnd |
| PipelineName |
PipelineName |
| Status |
Status |
| ActivityName |
Aktivitätsname |
| ActivityRunStart |
ActivityRunStart |
| ActivityRunEnd |
ActivityRunEnd |
| TriggerName |
Auslösername |
| TriggerRunTimestamp |
TriggerRunTimestamp |