Partilhar via

Activity Runs - Query By Pipeline Run

  • Referência
Serviço:
Data Factory
Versão da API:
2018-06-01

A atividade de consulta é executada com base nas condições do filtro de entrada.

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

Parâmetros do URI

Name Em Necessário Tipo Description
factoryName
 path True

string

O nome da fábrica.

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

string

O nome do grupo de recursos.

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

string

O identificador de execução do pipeline.
subscriptionId
 path True

string

O identificador da subscrição.
api-version
 query True

string

A versão da API.

Corpo do Pedido

Name Necessário Tipo Description
lastUpdatedAfter True

string

A hora em que o evento de execução foi atualizado no formato "ISO 8601".
lastUpdatedBefore True

string

A hora em que o evento de execução foi atualizado no formato "ISO 8601".
continuationToken

string

O token de continuação para obter a página seguinte dos resultados. Nulo para a primeira página.
filters

RunQueryFilter[]

Lista de filtros.
orderBy

RunQueryOrderBy[]

Lista da opção OrdenarPor.

Respostas

Name Tipo Description
200 OK

ActivityRunsQueryResponse

OK.
Other Status Codes

CloudError

Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ActivityRuns_QueryByPipelineRun

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
    }
  ]
}

Definições

Name Description
ActivityRun

Informações sobre uma execução de atividade num pipeline.
ActivityRunsQueryResponse

É executada uma atividade de lista.
CloudError

O objeto que define a estrutura de uma resposta de erro Azure Data Factory.
RunFilterParameters

Parâmetros de consulta para execuções de listagem.
RunQueryFilter

Opção de filtro de consulta para execuções de listagem.
RunQueryFilterOperand

Nome do parâmetro a ser utilizado para filtrar. Os operandos permitidos para consultar execuções de pipelines são PipelineName, RunStart, RunEnd e Status; Para consultar as execuções de atividade são ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status e para as execuções de acionadores de consulta são TriggerName, TriggerRunTimestamp e Status.
RunQueryFilterOperator

Operador a ser utilizado para filtrar.
RunQueryOrder

Sequência de ordenação do parâmetro .
RunQueryOrderBy

Um objeto para fornecer opções de ordem por para a listagem de execuções.
RunQueryOrderByField

Nome do parâmetro a utilizar para ordenar por. Os parâmetros permitidos para ordenar por para execuções de pipeline são PipelineName, RunStart, RunEnd e Status; para execuções de atividades, são ActivityName, ActivityRunStart, ActivityRunEnd e Status; para as execuções de acionadores são TriggerName, TriggerRunTimestamp e Status.

ActivityRun

Informações sobre uma execução de atividade num pipeline.

Name Tipo Description
activityName

string

O nome da atividade.
activityRunEnd

string

A hora de fim da execução da atividade no formato "ISO 8601".
activityRunId

string

O ID da execução da atividade.
activityRunStart

string

A hora de início da atividade é executada no formato "ISO 8601".
activityType

string

O tipo da atividade.
durationInMs

integer

A duração da execução da atividade.
error

object

O erro, se existir algum da execução da atividade.
input

object

A entrada para a atividade.
linkedServiceName

string

O nome do serviço ligado de computação.
output

object

O resultado da atividade.
pipelineName

string

O nome do pipeline.
pipelineRunId

string

O ID da execução do pipeline.
status

string

O estado da execução da atividade.

ActivityRunsQueryResponse

É executada uma atividade de lista.

Name Tipo Description
continuationToken

string

O token de continuação para obter a página seguinte de resultados, caso existam resultados restantes, é nulo.
value

ActivityRun[]

Lista de execuções de atividade.

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Data Factory.

Name Tipo Description
error.code

string

Código de erro.
error.details

CloudError[]

Matriz com detalhes de erro adicionais.
error.message

string

Mensagem de erro.
error.target

string

Nome/caminho da propriedade no pedido associado ao erro.

RunFilterParameters

Parâmetros de consulta para execuções de listagem.

Name Tipo Description
continuationToken

string

O token de continuação para obter a página seguinte dos resultados. Nulo para a primeira página.
filters

RunQueryFilter[]

Lista de filtros.
lastUpdatedAfter

string

A hora em que o evento de execução foi atualizado no formato "ISO 8601".
lastUpdatedBefore

string

A hora em que o evento de execução foi atualizado no formato "ISO 8601".
orderBy

RunQueryOrderBy[]

Lista da opção OrdenarPor.

RunQueryFilter

Opção de filtro de consulta para execuções de listagem.

Name Tipo Description
operand

RunQueryFilterOperand

Nome do parâmetro a ser utilizado para filtrar. Os operandos permitidos para consultar execuções de pipelines são PipelineName, RunStart, RunEnd e Status; Para consultar as execuções de atividade são ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status e para as execuções de acionadores de consulta são TriggerName, TriggerRunTimestamp e Status.
operator

RunQueryFilterOperator

Operador a ser utilizado para filtrar.
values

string[]

Lista de valores de filtro.

RunQueryFilterOperand

Nome do parâmetro a ser utilizado para filtrar. Os operandos permitidos para consultar execuções de pipelines são PipelineName, RunStart, RunEnd e Status; Para consultar as execuções de atividade são ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType e Status e para as execuções de acionadores de consulta são TriggerName, TriggerRunTimestamp e Status.

Name Tipo 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

Operador a ser utilizado para filtrar.

Name Tipo Description
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

Sequência de ordenação do parâmetro .

Name Tipo Description
ASC

string

DESC

string

RunQueryOrderBy

Um objeto para fornecer opções de ordem por para a listagem de execuções.

Name Tipo Description
order

RunQueryOrder

Sequência de ordenação do parâmetro .
orderBy

RunQueryOrderByField

Nome do parâmetro a utilizar para ordenar por. Os parâmetros permitidos para ordenar por para execuções de pipeline são PipelineName, RunStart, RunEnd e Status; para execuções de atividades, são ActivityName, ActivityRunStart, ActivityRunEnd e Status; para as execuções de acionadores são TriggerName, TriggerRunTimestamp e Status.

RunQueryOrderByField

Nome do parâmetro a utilizar para ordenar por. Os parâmetros permitidos para ordenar por para execuções de pipeline são PipelineName, RunStart, RunEnd e Status; para execuções de atividades, são ActivityName, ActivityRunStart, ActivityRunEnd e Status; para as execuções de acionadores são TriggerName, TriggerRunTimestamp e Status.

Name Tipo Description
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string