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 |
---|---|---|---|---|
factory
|
path | True |
string |
Nome della factory. Criterio di espressione regolare: |
resource
|
path | True |
string |
Il nome del gruppo di risorse. Criterio di espressione regolare: |
run
|
path | True |
string |
Identificatore di esecuzione della pipeline. |
subscription
|
path | True |
string |
L'identificatore della sottoscrizione. |
api-version
|
query | True |
string |
La versione delle API. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
lastUpdatedAfter | True |
string |
Ora dopo la quale l'evento di esecuzione è stato aggiornato nel formato 'ISO 8601'. |
lastUpdatedBefore | True |
string |
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 |
Elenco di filtri. |
||
orderBy |
Elenco dell'opzione OrderBy. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Risposta di errore ricevuta dal servizio Azure Data Factory. |
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-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"
}
Risposta di esempio
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"
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Activity |
Informazioni su un'esecuzione di attività in una pipeline. |
Activity |
Viene eseguita un'attività elenco. |
Cloud |
Oggetto che definisce la struttura di una risposta di errore Azure Data Factory. |
Run |
Parametri di query per l'elenco delle esecuzioni. |
Run |
Opzione di filtro query per l'elenco delle esecuzioni. |
Run |
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 di trigger di query sono TriggerName, TriggerRunTimestamp e Status. |
Run |
Operatore da utilizzare per il filtro. |
Run |
Ordinamento del parametro. |
Run |
Oggetto per fornire l'ordine in base alle opzioni per l'elenco delle esecuzioni. |
Run |
Nome del parametro da utilizzare per l'ordine. I parametri consentiti 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 di trigger sono TriggerName, TriggerRunTimestamp e Status. |
ActivityRun
Informazioni su un'esecuzione di attività in una pipeline.
Nome | Tipo | Descrizione |
---|---|---|
activityName |
string |
Nome dell'attività. |
activityRunEnd |
string |
Ora di fine dell'esecuzione dell'attività in formato 'ISO 8601'. |
activityRunId |
string |
ID dell'esecuzione dell'attività. |
activityRunStart |
string |
Ora di inizio dell'esecuzione dell'attività in formato 'ISO 8601'. |
activityType |
string |
Tipo dell'attività. |
durationInMs |
integer |
Durata dell'esecuzione dell'attività. |
error |
object |
Errore se presente nell'esecuzione dell'attività. |
input |
object |
Input per l'attività. |
linkedServiceName |
string |
Nome del servizio collegato di calcolo. |
output |
object |
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à 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 |
Elenco di esecuzioni di attività. |
CloudError
Oggetto che definisce la struttura di una risposta di errore Azure Data Factory.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore. |
error.details |
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 |
Elenco di filtri. |
|
lastUpdatedAfter |
string |
Ora dopo la quale l'evento di esecuzione è stato aggiornato nel formato 'ISO 8601'. |
lastUpdatedBefore |
string |
Ora in cui l'evento di esecuzione è stato aggiornato in formato 'ISO 8601'. |
orderBy |
Elenco dell'opzione OrderBy. |
RunQueryFilter
Opzione di filtro query per l'elenco delle esecuzioni.
Nome | Tipo | Descrizione |
---|---|---|
operand |
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 di trigger di query sono TriggerName, TriggerRunTimestamp e Status. |
|
operator |
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 di trigger di query sono TriggerName, TriggerRunTimestamp e Status.
Nome | Tipo | Descrizione |
---|---|---|
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
Operatore da utilizzare per il filtro.
Nome | Tipo | Descrizione |
---|---|---|
Equals |
string |
|
In |
string |
|
NotEquals |
string |
|
NotIn |
string |
RunQueryOrder
Ordinamento del parametro.
Nome | Tipo | Descrizione |
---|---|---|
ASC |
string |
|
DESC |
string |
RunQueryOrderBy
Oggetto per fornire l'ordine in base alle opzioni per l'elenco delle esecuzioni.
Nome | Tipo | Descrizione |
---|---|---|
order |
Ordinamento del parametro. |
|
orderBy |
Nome del parametro da utilizzare per l'ordine. I parametri consentiti 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 di trigger sono TriggerName, TriggerRunTimestamp e Status. |
RunQueryOrderByField
Nome del parametro da utilizzare per l'ordine. I parametri consentiti 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 di trigger sono TriggerName, TriggerRunTimestamp e Status.
Nome | Tipo | Descrizione |
---|---|---|
ActivityName |
string |
|
ActivityRunEnd |
string |
|
ActivityRunStart |
string |
|
PipelineName |
string |
|
RunEnd |
string |
|
RunStart |
string |
|
Status |
string |
|
TriggerName |
string |
|
TriggerRunTimestamp |
string |