Dela via

Activity Runs - Query By Pipeline Run

  • Referens
Tjänst:
Data Factory
API-version:
2018-06-01

Frågeaktiviteten körs baserat på villkor för indatafilter.

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

URI-parametrar

Name I Obligatorisk Typ Description
factoryName
 path True

string

Fabriksnamnet.

Reguljärt uttrycksmönster: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName
 path True

string

Resursgruppens namn.

Reguljärt uttrycksmönster: ^[-\w\._\(\)]+$
runId
 path True

string

Identifieraren för pipelinekörning.
subscriptionId
 path True

string

Prenumerationsidentifieraren.
api-version
 query True

string

API-versionen.

Begärandetext

Name Obligatorisk Typ Description
lastUpdatedAfter True

string

Tidpunkten då körningshändelsen uppdaterades i ISO 8601-format.
lastUpdatedBefore True

string

Tidpunkten då körningshändelsen uppdaterades i ISO 8601-format.
continuationToken

string

Fortsättningstoken för att hämta nästa sida med resultat. Null för första sidan.
filters

RunQueryFilter[]

Lista över filter.
orderBy

RunQueryOrderBy[]

Lista över alternativet OrderBy.

Svar

Name Typ Description
200 OK

ActivityRunsQueryResponse

OK.
Other Status Codes

CloudError

Ett felsvar som tagits emot från Azure Data Factory-tjänsten.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ActivityRuns_QueryByPipelineRun

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ActivityRun

Information om en aktivitet som körs i en pipeline.
ActivityRunsQueryResponse

En listaktivitet körs.
CloudError

Objektet som definierar strukturen för ett Azure Data Factory felsvar.
RunFilterParameters

Frågeparametrar för listkörningar.
RunQueryFilter

Frågefilteralternativ för listkörningar.
RunQueryFilterOperand

Parameternamn som ska användas för filter. Tillåtna operander för att köra frågor mot pipelinekörningar är PipelineName, RunStart, RunEnd och Status. till frågeaktivitetskörningar är ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType och Status, och för frågeutlösarkörningar är TriggerName, TriggerRunTimestamp och Status.
RunQueryFilterOperator

Operator som ska användas för filter.
RunQueryOrder

Sorteringsordning för parametern.
RunQueryOrderBy

Ett objekt som ger ordning efter alternativ för listkörningar.
RunQueryOrderByField

Parameternamn som ska användas för beställning av. De tillåtna parametrarna som ska beställas efter för pipelinekörningar är PipelineName, RunStart, RunEnd och Status. för aktivitetskörningar är ActivityName, ActivityRunStart, ActivityRunEnd och Status; för utlösarkörningar är TriggerName, TriggerRunTimestamp och Status.

ActivityRun

Information om en aktivitet som körs i en pipeline.

Name Typ Description
activityName

string

Namnet på aktiviteten.
activityRunEnd

string

Sluttiden för aktiviteten körs i formatet ISO 8601.
activityRunId

string

ID för aktivitetskörningen.
activityRunStart

string

Starttiden för aktiviteten körs i formatet ISO 8601.
activityType

string

Typen av aktivitet.
durationInMs

integer

Varaktigheten för aktivitetskörningen.
error

object

Felet om det finns något från aktivitetskörningen.
input

object

Indata för aktiviteten.
linkedServiceName

string

Namnet på den länkade beräkningstjänsten.
output

object

Utdata för aktiviteten.
pipelineName

string

Namnet på pipelinen.
pipelineRunId

string

ID:t för pipelinekörningen.
status

string

Status för aktivitetskörningen.

ActivityRunsQueryResponse

En listaktivitet körs.

Name Typ Description
continuationToken

string

Fortsättningstoken för att hämta nästa sida med resultat, om det finns några återstående resultat, null annars.
value

ActivityRun[]

Lista över aktivitetskörningar.

CloudError

Objektet som definierar strukturen för ett Azure Data Factory felsvar.

Name Typ Description
error.code

string

Felkod.
error.details

CloudError[]

Matris med ytterligare felinformation.
error.message

string

Felmeddelande.
error.target

string

Egenskapsnamn/sökväg i begäran som är associerad med fel.

RunFilterParameters

Frågeparametrar för listkörningar.

Name Typ Description
continuationToken

string

Fortsättningstoken för att hämta nästa sida med resultat. Null för första sidan.
filters

RunQueryFilter[]

Lista över filter.
lastUpdatedAfter

string

Tidpunkten då körningshändelsen uppdaterades i ISO 8601-format.
lastUpdatedBefore

string

Tidpunkten då körningshändelsen uppdaterades i ISO 8601-format.
orderBy

RunQueryOrderBy[]

Lista över alternativet OrderBy.

RunQueryFilter

Frågefilteralternativ för listkörningar.

Name Typ Description
operand

RunQueryFilterOperand

Parameternamn som ska användas för filter. Tillåtna operander för att köra frågor mot pipelinekörningar är PipelineName, RunStart, RunEnd och Status. till frågeaktivitetskörningar är ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType och Status, och för frågeutlösarkörningar är TriggerName, TriggerRunTimestamp och Status.
operator

RunQueryFilterOperator

Operator som ska användas för filter.
values

string[]

Lista över filtervärden.

RunQueryFilterOperand

Parameternamn som ska användas för filter. Tillåtna operander för att köra frågor mot pipelinekörningar är PipelineName, RunStart, RunEnd och Status. till frågeaktivitetskörningar är ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType och Status, och för frågeutlösarkörningar är TriggerName, TriggerRunTimestamp och Status.

Name Typ 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 som ska användas för filter.

Name Typ Description
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

Sorteringsordning för parametern.

Name Typ Description
ASC

string

DESC

string

RunQueryOrderBy

Ett objekt som ger ordning efter alternativ för listkörningar.

Name Typ Description
order

RunQueryOrder

Sorteringsordning för parametern.
orderBy

RunQueryOrderByField

Parameternamn som ska användas för beställning av. De tillåtna parametrarna som ska beställas efter för pipelinekörningar är PipelineName, RunStart, RunEnd och Status. för aktivitetskörningar är ActivityName, ActivityRunStart, ActivityRunEnd och Status; för utlösarkörningar är TriggerName, TriggerRunTimestamp och Status.

RunQueryOrderByField

Parameternamn som ska användas för beställning av. De tillåtna parametrarna som ska beställas efter för pipelinekörningar är PipelineName, RunStart, RunEnd och Status. för aktivitetskörningar är ActivityName, ActivityRunStart, ActivityRunEnd och Status; för utlösarkörningar är TriggerName, TriggerRunTimestamp och Status.

Name Typ Description
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string