Partilhar via


Activity Runs - Query By Pipeline Run

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

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

O nome da fábrica.

resourceGroupName
path True

string

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

O nome do grupo de recursos.

runId
path True

string

O identificador de execução do pipeline.

subscriptionId
path True

string

O identificador de assinatura.

api-version
query True

string

A versão da API.

Corpo do Pedido

Name Necessário Tipo Description
lastUpdatedAfter True

string (date-time)

A hora em que ou após a qual o evento de execução foi atualizado no formato 'ISO 8601'.

lastUpdatedBefore True

string (date-time)

A hora em que ou antes da qual o evento de execução foi atualizado no formato 'ISO 8601'.

continuationToken

string

O token de continuação para obter a próxima página de resultados. Nulo para a primeira página.

filters

RunQueryFilter[]

Lista de filtros.

orderBy

RunQueryOrderBy[]

Lista da opção OrderBy.

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 Ative Directory.

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

Âmbitos

Name Description
user_impersonation personificar 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

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 atividade executada em um pipeline.

ActivityRunsQueryResponse

Uma atividade de lista é executada.

CloudError

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

RunFilterParameters

Os parâmetros de consulta para listar são executados.

RunQueryFilter

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

RunQueryFilterOperand

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

RunQueryFilterOperator

Operador a ser usado para filtro.

RunQueryOrder

Ordem de classificação do parâmetro.

RunQueryOrderBy

Um objeto para fornecer ordem por opções para listar é executado.

RunQueryOrderByField

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

ActivityRun

Informações sobre uma atividade executada em um pipeline.

Name Tipo Description
activityName

string

O nome da atividade.

activityRunEnd

string (date-time)

A hora de término da atividade é executada no formato 'ISO 8601'.

activityRunId

string

O id da atividade executada.

activityRunStart

string (date-time)

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

activityType

string

O tipo de atividade.

durationInMs

integer

A duração da atividade executada.

error

object

O erro, se houver, da atividade executada.

input

object

A entrada para a atividade.

linkedServiceName

string

O nome do serviço vinculado de computação.

output

object

A saída para a atividade.

pipelineName

string

O nome do gasoduto.

pipelineRunId

string

A id da execução do pipeline.

status

string

O status da atividade executada.

ActivityRunsQueryResponse

Uma atividade de lista é executada.

Name Tipo Description
continuationToken

string

O token de continuação para obter a próxima página de resultados, se existirem resultados restantes, anulará caso contrário.

value

ActivityRun[]

Lista de execuções de atividade.

CloudError

O objeto que define a estrutura de uma resposta de erro do 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 na solicitação associada ao erro.

RunFilterParameters

Os parâmetros de consulta para listar são executados.

Name Tipo Description
continuationToken

string

O token de continuação para obter a próxima página de resultados. Nulo para a primeira página.

filters

RunQueryFilter[]

Lista de filtros.

lastUpdatedAfter

string (date-time)

A hora em que ou após a qual o evento de execução foi atualizado no formato 'ISO 8601'.

lastUpdatedBefore

string (date-time)

A hora em que ou antes da qual o evento de execução foi atualizado no formato 'ISO 8601'.

orderBy

RunQueryOrderBy[]

Lista da opção OrderBy.

RunQueryFilter

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

Name Tipo Description
operand

RunQueryFilterOperand

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

operator

RunQueryFilterOperator

Operador a ser usado para filtro.

values

string[]

Lista de valores de filtro.

RunQueryFilterOperand

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

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

RunQueryFilterOperator

Operador a ser usado para filtro.

Valor Description
Equals
NotEquals
In
NotIn

RunQueryOrder

Ordem de classificação do parâmetro.

Valor Description
ASC
DESC

RunQueryOrderBy

Um objeto para fornecer ordem por opções para listar é executado.

Name Tipo Description
order

RunQueryOrder

Ordem de classificação do parâmetro.

orderBy

RunQueryOrderByField

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

RunQueryOrderByField

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

Valor Description
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp