Freigeben über


Activity Runs - Query By Pipeline Run

Die 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
factoryName
path True

string

Der Factoryname.

RegEx-Muster: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

RegEx-Muster: ^[-\w\._\(\)]+$

runId
path True

string

Der Bezeichner für die Pipelineausführung.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
lastUpdatedAfter True

string

Die Zeit um oder nach der das Ausführungsereignis im FORMAT "ISO 8601" aktualisiert wurde.

lastUpdatedBefore True

string

Die Zeit um oder vor der das Ausführungsereignis im FORMAT "ISO 8601" aktualisiert wurde.

continuationToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Null für die erste Seite.

filters

RunQueryFilter[]

Liste der Filter.

orderBy

RunQueryOrderBy[]

List of OrderBy-Option.

Antworten

Name Typ Beschreibung
200 OK

ActivityRunsQueryResponse

OK.

Other Status Codes

CloudError

Eine vom Azure Data Factory Dienst empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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-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"
}

Beispiel für eine Antwort

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"
    }
  ]
}

Definitionen

Name Beschreibung
ActivityRun

Informationen zu einer Aktivität, die in einer Pipeline ausgeführt wird.

ActivityRunsQueryResponse

Eine Listenaktivität wird ausgeführt.

CloudError

Das -Objekt, das die Struktur einer Azure Data Factory Fehlerantwort definiert.

RunFilterParameters

Abfrageparameter für Auflistungsausführungen.

RunQueryFilter

Abfragefilteroption für Auflistungsausführungen.

RunQueryFilterOperand

Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden zum Abfragen von Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. zum Abfragen von Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status und zum Abfragen von Triggerausführungen TriggerName, TriggerRunTimestamp und Status.

RunQueryFilterOperator

Operator, der für den Filter verwendet werden soll.

RunQueryOrder

Sortierreihenfolge des Parameters.

RunQueryOrderBy

Ein Objekt zum Bereitstellen von Reihenfolge nach Optionen für die Auflistung von Ausführungen.

RunQueryOrderByField

Parametername, der für die Reihenfolge von verwendet werden soll. Die zulässigen Parameter für Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. für Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerausführungen 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

Die Endzeit der Aktivitätsausführung im FORMAT "ISO 8601".

activityRunId

string

Die ID der Aktivitätsausführung.

activityRunStart

string

Die Startzeit der Aktivitätsausführung im FORMAT "ISO 8601".

activityType

string

Der Typ der Aktivität.

durationInMs

integer

Die Dauer der Aktivitätsausführung.

error

object

Der Fehler, falls vorhanden aus der Aktivitätsausführung.

input

object

Die Eingabe für die Aktivität.

linkedServiceName

string

Der Name des verknüpften Computediensts.

output

object

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 für das Abrufen der nächsten Ergebnisseite, wenn verbleibende Ergebnisse vorhanden sind, andernfalls NULL.

value

ActivityRun[]

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

CloudError[]

Array mit zusätzlichen Fehlerdetails.

error.message

string

Fehlermeldung.

error.target

string

Eigenschaftsname/Pfad in der Anforderung, die einem Fehler zugeordnet ist.

RunFilterParameters

Abfrageparameter für Auflistungsausführungen.

Name Typ Beschreibung
continuationToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Null für die erste Seite.

filters

RunQueryFilter[]

Liste der Filter.

lastUpdatedAfter

string

Die Zeit um oder nach der das Ausführungsereignis im FORMAT "ISO 8601" aktualisiert wurde.

lastUpdatedBefore

string

Die Zeit um oder vor der das Ausführungsereignis im FORMAT "ISO 8601" aktualisiert wurde.

orderBy

RunQueryOrderBy[]

List of OrderBy-Option.

RunQueryFilter

Abfragefilteroption für Auflistungsausführungen.

Name Typ Beschreibung
operand

RunQueryFilterOperand

Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden zum Abfragen von Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. zum Abfragen von Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status und zum Abfragen von Triggerausführungen TriggerName, TriggerRunTimestamp und Status.

operator

RunQueryFilterOperator

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 zum Abfragen von Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. zum Abfragen von Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status und zum Abfragen von Triggerausführungen TriggerName, TriggerRunTimestamp und Status.

Name Typ Beschreibung
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, der für den Filter verwendet werden soll.

Name Typ Beschreibung
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

Sortierreihenfolge des Parameters.

Name Typ Beschreibung
ASC

string

DESC

string

RunQueryOrderBy

Ein Objekt zum Bereitstellen von Reihenfolge nach Optionen für die Auflistung von Ausführungen.

Name Typ Beschreibung
order

RunQueryOrder

Sortierreihenfolge des Parameters.

orderBy

RunQueryOrderByField

Parametername, der für die Reihenfolge von verwendet werden soll. Die zulässigen Parameter für Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. für Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerausführungen sind TriggerName, TriggerRunTimestamp und Status.

RunQueryOrderByField

Parametername, der für die Reihenfolge von verwendet werden soll. Die zulässigen Parameter für Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. für Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerausführungen sind TriggerName, TriggerRunTimestamp und Status.

Name Typ Beschreibung
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string