Partager via


Activity Runs - Query By Pipeline Run

L’activité de requête s’exécute en fonction des conditions de filtre d’entrée.

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

Paramètres URI

Nom Dans Obligatoire Type Description
factoryName
path True

string

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

Nom de la fabrique.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

Nom du groupe de ressources.

runId
path True

string

Identificateur d’exécution du pipeline.

subscriptionId
path True

string

Identificateur d’abonnement.

api-version
query True

string

Version de l’API.

Corps de la demande

Nom Obligatoire Type Description
lastUpdatedAfter True

string (date-time)

Heure à laquelle l’événement d’exécution a été mis à jour au format « ISO 8601 ».

lastUpdatedBefore True

string (date-time)

Heure à laquelle l’événement d’exécution a été mis à jour au format « ISO 8601 ».

continuationToken

string

Jeton de continuation pour obtenir la page suivante des résultats. Null pour la première page.

filters

RunQueryFilter[]

Liste des filtres.

orderBy

RunQueryOrderBy[]

Liste de l’option OrderBy.

Réponses

Nom Type Description
200 OK

ActivityRunsQueryResponse

D’ACCORD.

Other Status Codes

CloudError

Réponse d’erreur reçue du service Azure Data Factory.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ActivityRuns_QueryByPipelineRun

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ActivityRun

Informations sur une activité exécutée dans un pipeline.

ActivityRunsQueryResponse

Une activité de liste s’exécute.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

RunFilterParameters

Paramètres de requête pour répertorier les exécutions.

RunQueryFilter

Option de filtre de requête pour répertorier les exécutions.

RunQueryFilterOperand

Nom du paramètre à utiliser pour le filtre. Les opérandes autorisés pour interroger les exécutions de pipeline sont PipelineName, RunStart, RunEnd et Status ; pour interroger les exécutions d’activité sont ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType et Status, et les exécutions du déclencheur de requête sont TriggerName, TriggerRunTimestamp et Status.

RunQueryFilterOperator

Opérateur à utiliser pour le filtre.

RunQueryOrder

Ordre de tri du paramètre.

RunQueryOrderBy

Objet permettant de fournir un ordre par options pour les exécutions de liste.

RunQueryOrderByField

Nom du paramètre à utiliser pour l’ordre par. Les paramètres autorisés à commander pour les exécutions de pipeline sont PipelineName, RunStart, RunEnd et Status ; pour les exécutions d’activité sont ActivityName, ActivityRunStart, ActivityRunEnd et Status ; pour les exécutions de déclencheur sont TriggerName, TriggerRunTimestamp et Status.

ActivityRun

Informations sur une activité exécutée dans un pipeline.

Nom Type Description
activityName

string

Le nom de l’activité.

activityRunEnd

string (date-time)

Heure de fin de l’activité exécutée au format « ISO 8601 ».

activityRunId

string

ID de l’exécution de l’activité.

activityRunStart

string (date-time)

Heure de début de l’activité exécutée au format « ISO 8601 ».

activityType

string

Type de l’activité.

durationInMs

integer

Durée de l’exécution de l’activité.

error

object

Erreur si l’une des activités s’exécute.

input

object

Entrée de l’activité.

linkedServiceName

string

Nom du service lié de calcul.

output

object

Sortie de l’activité.

pipelineName

string

Nom du pipeline.

pipelineRunId

string

ID de l’exécution du pipeline.

status

string

État de l’exécution de l’activité.

ActivityRunsQueryResponse

Une activité de liste s’exécute.

Nom Type Description
continuationToken

string

Jeton de continuation pour obtenir la page suivante des résultats, si des résultats restants existent, null sinon.

value

ActivityRun[]

Liste des exécutions d’activité.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

Nom Type Description
error.code

string

Code d’erreur.

error.details

CloudError[]

Tableau avec des détails d’erreur supplémentaires.

error.message

string

Message d'erreur.

error.target

string

Nom/chemin de propriété dans la requête associée à l’erreur.

RunFilterParameters

Paramètres de requête pour répertorier les exécutions.

Nom Type Description
continuationToken

string

Jeton de continuation pour obtenir la page suivante des résultats. Null pour la première page.

filters

RunQueryFilter[]

Liste des filtres.

lastUpdatedAfter

string (date-time)

Heure à laquelle l’événement d’exécution a été mis à jour au format « ISO 8601 ».

lastUpdatedBefore

string (date-time)

Heure à laquelle l’événement d’exécution a été mis à jour au format « ISO 8601 ».

orderBy

RunQueryOrderBy[]

Liste de l’option OrderBy.

RunQueryFilter

Option de filtre de requête pour répertorier les exécutions.

Nom Type Description
operand

RunQueryFilterOperand

Nom du paramètre à utiliser pour le filtre. Les opérandes autorisés pour interroger les exécutions de pipeline sont PipelineName, RunStart, RunEnd et Status ; pour interroger les exécutions d’activité sont ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType et Status, et les exécutions du déclencheur de requête sont TriggerName, TriggerRunTimestamp et Status.

operator

RunQueryFilterOperator

Opérateur à utiliser pour le filtre.

values

string[]

Liste des valeurs de filtre.

RunQueryFilterOperand

Nom du paramètre à utiliser pour le filtre. Les opérandes autorisés pour interroger les exécutions de pipeline sont PipelineName, RunStart, RunEnd et Status ; pour interroger les exécutions d’activité sont ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType et Status, et les exécutions du déclencheur de requête sont TriggerName, TriggerRunTimestamp et Status.

Valeur Description
ActivityName
ActivityRunEnd
ActivityRunStart
ActivityType
LatestOnly
PipelineName
RunEnd
RunGroupId
RunStart
Status
TriggerName
TriggerRunTimestamp

RunQueryFilterOperator

Opérateur à utiliser pour le filtre.

Valeur Description
Equals
In
NotEquals
NotIn

RunQueryOrder

Ordre de tri du paramètre.

Valeur Description
ASC
DESC

RunQueryOrderBy

Objet permettant de fournir un ordre par options pour les exécutions de liste.

Nom Type Description
order

RunQueryOrder

Ordre de tri du paramètre.

orderBy

RunQueryOrderByField

Nom du paramètre à utiliser pour l’ordre par. Les paramètres autorisés à commander pour les exécutions de pipeline sont PipelineName, RunStart, RunEnd et Status ; pour les exécutions d’activité sont ActivityName, ActivityRunStart, ActivityRunEnd et Status ; pour les exécutions de déclencheur sont TriggerName, TriggerRunTimestamp et Status.

RunQueryOrderByField

Nom du paramètre à utiliser pour l’ordre par. Les paramètres autorisés à commander pour les exécutions de pipeline sont PipelineName, RunStart, RunEnd et Status ; pour les exécutions d’activité sont ActivityName, ActivityRunStart, ActivityRunEnd et Status ; pour les exécutions de déclencheur sont TriggerName, TriggerRunTimestamp et Status.

Valeur Description
ActivityName
ActivityRunEnd
ActivityRunStart
PipelineName
RunEnd
RunStart
Status
TriggerName
TriggerRunTimestamp