Condividi tramite


Activity Runs - Query By Pipeline Run

L'attività di query viene eseguita in base alle condizioni del filtro di input.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
factoryName
path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

runId
path True

string

Identificatore di esecuzione della pipeline.

subscriptionId
path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
lastUpdatedAfter True

string (date-time)

Ora in cui l'evento di esecuzione è stato aggiornato in formato "ISO 8601".

lastUpdatedBefore True

string (date-time)

Ora in cui l'evento di esecuzione è stato aggiornato in formato 'ISO 8601'.

continuationToken

string

Token di continuazione per ottenere la pagina successiva dei risultati. Null per la prima pagina.

filters

RunQueryFilter[]

Elenco di filtri.

orderBy

RunQueryOrderBy[]

Elenco dell'opzione OrderBy.

Risposte

Nome Tipo Descrizione
200 OK

ActivityRunsQueryResponse

Operazione Azure completata con successo.

Other Status Codes

CloudError

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ActivityRuns_QueryByPipelineRun

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ActivityRun

Informazioni su un'esecuzione di attività in una pipeline.

ActivityRunsQueryResponse

Viene eseguita un'attività di elenco.

CloudError

Oggetto che definisce la struttura di una risposta di errore di Azure Data Factory.

RunFilterParameters

Parametri di query per l'elenco delle esecuzioni.

RunQueryFilter

Opzione filtro query per l'elenco delle esecuzioni.

RunQueryFilterOperand

Nome del parametro da usare per il filtro. Gli operandi consentiti per eseguire query sulle esecuzioni della pipeline sono PipelineName, RunStart, RunEnd e Status; per eseguire query sulle esecuzioni di attività sono ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status e per le esecuzioni dei trigger di query sono TriggerName, TriggerRunTimestamp e Status.

RunQueryFilterOperator

Operatore da utilizzare per il filtro.

RunQueryOrder

Ordinamento del parametro.

RunQueryOrderBy

Oggetto per fornire l'ordine in base alle opzioni per l'elenco delle esecuzioni.

RunQueryOrderByField

Nome del parametro da utilizzare per l'ordine. I parametri consentiti da ordinare per le esecuzioni della pipeline sono PipelineName, RunStart, RunEnd e Status; per le esecuzioni di attività sono ActivityName, ActivityRunStart, ActivityRunEnd e Status; per le esecuzioni dei trigger sono TriggerName, TriggerRunTimestamp e Status.

ActivityRun

Informazioni su un'esecuzione di attività in una pipeline.

Nome Tipo Descrizione
activityName

string

Il nome dell'impegno.

activityRunEnd

string (date-time)

Ora di fine dell'esecuzione dell'attività nel formato 'ISO 8601'.

activityRunId

string

ID dell'esecuzione dell'attività.

activityRunStart

string (date-time)

Ora di inizio dell'esecuzione dell'attività nel formato 'ISO 8601'.

activityType

string

Tipo dell'attività.

durationInMs

integer (int32)

Durata dell'esecuzione dell'attività.

error

Errore se presente nell'esecuzione dell'attività.

input

Input per l'attività.

linkedServiceName

string

Nome del servizio collegato di calcolo.

output

Output dell'attività.

pipelineName

string

Nome della pipeline.

pipelineRunId

string

ID dell'esecuzione della pipeline.

status

string

Stato dell'esecuzione dell'attività.

ActivityRunsQueryResponse

Viene eseguita un'attività di elenco.

Nome Tipo Descrizione
continuationToken

string

Token di continuazione per ottenere la pagina successiva dei risultati, se esistono risultati rimanenti, null in caso contrario.

value

ActivityRun[]

Elenco delle esecuzioni di attività.

CloudError

Oggetto che definisce la struttura di una risposta di errore di Azure Data Factory.

Nome Tipo Descrizione
error.code

string

Codice di errore.

error.details

CloudError[]

Matrice con dettagli aggiuntivi sull'errore.

error.message

string

Messaggio di errore.

error.target

string

Nome/percorso della proprietà nella richiesta associata all'errore.

RunFilterParameters

Parametri di query per l'elenco delle esecuzioni.

Nome Tipo Descrizione
continuationToken

string

Token di continuazione per ottenere la pagina successiva dei risultati. Null per la prima pagina.

filters

RunQueryFilter[]

Elenco di filtri.

lastUpdatedAfter

string (date-time)

Ora in cui l'evento di esecuzione è stato aggiornato in formato "ISO 8601".

lastUpdatedBefore

string (date-time)

Ora in cui l'evento di esecuzione è stato aggiornato in formato 'ISO 8601'.

orderBy

RunQueryOrderBy[]

Elenco dell'opzione OrderBy.

RunQueryFilter

Opzione filtro query per l'elenco delle esecuzioni.

Nome Tipo Descrizione
operand

RunQueryFilterOperand

Nome del parametro da usare per il filtro. Gli operandi consentiti per eseguire query sulle esecuzioni della pipeline sono PipelineName, RunStart, RunEnd e Status; per eseguire query sulle esecuzioni di attività sono ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status e per le esecuzioni dei trigger di query sono TriggerName, TriggerRunTimestamp e Status.

operator

RunQueryFilterOperator

Operatore da utilizzare per il filtro.

values

string[]

Elenco di valori di filtro.

RunQueryFilterOperand

Nome del parametro da usare per il filtro. Gli operandi consentiti per eseguire query sulle esecuzioni della pipeline sono PipelineName, RunStart, RunEnd e Status; per eseguire query sulle esecuzioni di attività sono ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status e per le esecuzioni dei trigger di query sono TriggerName, TriggerRunTimestamp e Status.

Valore Descrizione
PipelineName

PipelineName

Status

Condizione

RunStart

RunStart

RunEnd

RunEnd

ActivityName

NomeAttività

ActivityRunStart

ActivityRunStart

ActivityRunEnd

ActivityRunEnd

ActivityType

Tipo di attività

TriggerName

Nome del Trigger

TriggerRunTimestamp

TriggerRunTimestamp

RunGroupId

RunGroupId

LatestOnly

UltimoOnly

RunQueryFilterOperator

Operatore da utilizzare per il filtro.

Valore Descrizione
Equals

Uguale

NotEquals

NotEquals

In

In

NotIn

NotIn

RunQueryOrder

Ordinamento del parametro.

Valore Descrizione
ASC

ASC

DESC

DESC

RunQueryOrderBy

Oggetto per fornire l'ordine in base alle opzioni per l'elenco delle esecuzioni.

Nome Tipo Descrizione
order

RunQueryOrder

Ordinamento del parametro.

orderBy

RunQueryOrderByField

Nome del parametro da utilizzare per l'ordine. I parametri consentiti da ordinare per le esecuzioni della pipeline sono PipelineName, RunStart, RunEnd e Status; per le esecuzioni di attività sono ActivityName, ActivityRunStart, ActivityRunEnd e Status; per le esecuzioni dei trigger sono TriggerName, TriggerRunTimestamp e Status.

RunQueryOrderByField

Nome del parametro da utilizzare per l'ordine. I parametri consentiti da ordinare per le esecuzioni della pipeline sono PipelineName, RunStart, RunEnd e Status; per le esecuzioni di attività sono ActivityName, ActivityRunStart, ActivityRunEnd e Status; per le esecuzioni dei trigger sono TriggerName, TriggerRunTimestamp e Status.

Valore Descrizione
RunStart

RunStart

RunEnd

RunEnd

PipelineName

PipelineName

Status

Condizione

ActivityName

NomeAttività

ActivityRunStart

ActivityRunStart

ActivityRunEnd

ActivityRunEnd

TriggerName

Nome del Trigger

TriggerRunTimestamp

TriggerRunTimestamp