Activity Runs - Query By Pipeline Run

  • Referentie
Service:
Data Factory
API Version:
2018-06-01

Queryactiviteit wordt uitgevoerd op basis van invoerfiltervoorwaarden.

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

URI-parameters

Name In Vereist Type Description
factoryName
 path True

string

De naam van de fabriek.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName
 path True

string

De naam van de resourcegroep.

Regex pattern: ^[-\w\._\(\)]+$
runId
 path True

string

De id van de pijplijnuitvoering.
subscriptionId
 path True

string

De abonnements-id.
api-version
 query True

string

De API-versie.

Aanvraagbody

Name Vereist Type Description
lastUpdatedAfter True

string

De tijd op of waarna de uitvoeringsgebeurtenis is bijgewerkt in de indeling 'ISO 8601'.
lastUpdatedBefore True

string

De tijd op of vóór waarop de uitvoeringsgebeurtenis is bijgewerkt in de indeling 'ISO 8601'.
continuationToken

string

Het vervolgtoken voor het ophalen van de volgende pagina met resultaten. Null voor eerste pagina.
filters

RunQueryFilter[]

Lijst met filters.
orderBy

RunQueryOrderBy[]

Lijst met de optie OrderBy.

Antwoorden

Name Type Description
200 OK

ActivityRunsQueryResponse

OK.
Other Status Codes

CloudError

Er is een foutbericht ontvangen van de Azure Data Factory-service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ActivityRuns_QueryByPipelineRun

Sample Request

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

Sample Response

Status code:
200 
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
Response Body
{
  "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"
    }
  ]
}

Definities

Name Description
ActivityRun

Informatie over een activiteit die wordt uitgevoerd in een pijplijn.
ActivityRunsQueryResponse

Er wordt een lijstactiviteit uitgevoerd.
CloudError

Het object dat de structuur van een Azure Data Factory foutreactie definieert.
RunFilterParameters

Queryparameters voor het weergeven van uitvoeringen.
RunQueryFilter

Queryfilteroptie voor het weergeven van uitvoeringen.
RunQueryFilterOperand

Parameternaam die moet worden gebruikt voor het filter. De toegestane operands voor het uitvoeren van query's op pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; uitvoeringen van queryactiviteit zijn ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType en Status, en om triggeruitvoeringen op te vragen zijn TriggerName, TriggerRunTimestamp en Status.
RunQueryFilterOperator

Operator die moet worden gebruikt voor het filter.
RunQueryOrder

Sorteervolgorde van de parameter.
RunQueryOrderBy

Een object om opties voor volgorde op te geven voor het weergeven van uitvoeringen.
RunQueryOrderByField

Parameternaam die moet worden gebruikt voor order by. De toegestane parameters voor het bestellen van pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; voor activiteituitvoeringen zijn ActivityName, ActivityRunStart, ActivityRunEnd en Status; voor triggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status.

ActivityRun

Informatie over een activiteit die wordt uitgevoerd in een pijplijn.

Name Type Description
activityName

string

De naam van de activiteit.
activityRunEnd

string

De eindtijd van de uitvoering van de activiteit in de indeling 'ISO 8601'.
activityRunId

string

De id van de uitvoering van de activiteit.
activityRunStart

string

De begintijd van de uitvoering van de activiteit in de indeling 'ISO 8601'.
activityType

string

Het type activiteit.
durationInMs

integer

De duur van de uitvoering van de activiteit.
error

object

De fout, indien aanwezig, van de uitvoering van de activiteit.
input

object

De invoer voor de activiteit.
linkedServiceName

string

De naam van de gekoppelde rekenservice.
output

object

De uitvoer voor de activiteit.
pipelineName

string

De naam van de pijplijn.
pipelineRunId

string

De id van de pijplijnuitvoering.
status

string

De status van de uitvoering van de activiteit.

ActivityRunsQueryResponse

Er wordt een lijstactiviteit uitgevoerd.

Name Type Description
continuationToken

string

Het vervolgtoken voor het ophalen van de volgende pagina met resultaten, als er resterende resultaten bestaan, anders null.
value

ActivityRun[]

Lijst met activiteituitvoeringen.

CloudError

Het object dat de structuur van een Azure Data Factory foutreactie definieert.

Name Type Description
error.code

string

Foutcode.
error.details

CloudError[]

Matrix met aanvullende foutdetails.
error.message

string

Foutbericht.
error.target

string

Eigenschapsnaam/-pad in aanvraag die is gekoppeld aan een fout.

RunFilterParameters

Queryparameters voor het weergeven van uitvoeringen.

Name Type Description
continuationToken

string

Het vervolgtoken voor het ophalen van de volgende pagina met resultaten. Null voor eerste pagina.
filters

RunQueryFilter[]

Lijst met filters.
lastUpdatedAfter

string

De tijd op of waarna de uitvoeringsgebeurtenis is bijgewerkt in de indeling 'ISO 8601'.
lastUpdatedBefore

string

De tijd op of vóór waarop de uitvoeringsgebeurtenis is bijgewerkt in de indeling 'ISO 8601'.
orderBy

RunQueryOrderBy[]

Lijst met de optie OrderBy.

RunQueryFilter

Queryfilteroptie voor het weergeven van uitvoeringen.

Name Type Description
operand

RunQueryFilterOperand

Parameternaam die moet worden gebruikt voor het filter. De toegestane operands voor het uitvoeren van query's op pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; uitvoeringen van queryactiviteit zijn ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType en Status, en om triggeruitvoeringen op te vragen zijn TriggerName, TriggerRunTimestamp en Status.
operator

RunQueryFilterOperator

Operator die moet worden gebruikt voor het filter.
values

string[]

Lijst met filterwaarden.

RunQueryFilterOperand

Parameternaam die moet worden gebruikt voor het filter. De toegestane operands voor het uitvoeren van query's op pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; uitvoeringen van queryactiviteit zijn ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType en Status, en om triggeruitvoeringen op te vragen zijn TriggerName, TriggerRunTimestamp en Status.

Name Type Description
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 die moet worden gebruikt voor het filter.

Name Type Description
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

Sorteervolgorde van de parameter.

Name Type Description
ASC

string

DESC

string

RunQueryOrderBy

Een object om opties voor volgorde op te geven voor het weergeven van uitvoeringen.

Name Type Description
order

RunQueryOrder

Sorteervolgorde van de parameter.
orderBy

RunQueryOrderByField

Parameternaam die moet worden gebruikt voor order by. De toegestane parameters voor het bestellen van pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; voor activiteituitvoeringen zijn ActivityName, ActivityRunStart, ActivityRunEnd en Status; voor triggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status.

RunQueryOrderByField

Parameternaam die moet worden gebruikt voor order by. De toegestane parameters voor het bestellen van pijplijnuitvoeringen zijn PipelineName, RunStart, RunEnd en Status; voor activiteituitvoeringen zijn ActivityName, ActivityRunStart, ActivityRunEnd en Status; voor triggeruitvoeringen zijn TriggerName, TriggerRunTimestamp en Status.

Name Type Description
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string