Pipeline Run - Query Activity Runs

Служба:: Synapse

Версия API:: 2020-12-01

Действие запроса выполняется в зависимости от условий фильтра ввода.

POST {endpoint}/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns?api-version=2020-12-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка разработки рабочей области, например `https://myworkspace.dev.azuresynapse.net`.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	Имя конвейера.
runId	path	True	string	Идентификатор выполнения конвейера.
api-version	query	True	string	Версия КЛИЕНТСКОго API Synapse.

Текст запроса

Имя	Обязательно	Тип	Описание
lastUpdatedAfter	True	string (date-time)	Время или после обновления события выполнения в формате ISO 8601.
lastUpdatedBefore	True	string (date-time)	Время или до обновления события выполнения в формате ISO 8601.
continuationToken		string	Маркер продолжения для получения следующей страницы результатов. Null для первой страницы.
filters		RunQueryFilter[]	Список фильтров.
orderBy		RunQueryOrderBy[]	Список параметра OrderBy.

Ответы

Имя	Тип	Описание
200 OK	ActivityRunsQueryResponse	ХОРОШО.
Other Status Codes	CloudError	Ответ об ошибке, полученный от службы Azure Synapse.

Примеры

ActivityRuns_QueryByPipelineRun

Образец запроса

HTTP

POST exampleWorkspace.dev.azuresynapse.net/pipelines/examplePipeline/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b/queryActivityruns?api-version=2020-12-01

{
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
}

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
ActivityRun	Сведения о выполнении действия в конвейере.
ActivityRunsQueryResponse	Выполняется действие списка.
CloudError	Объект, определяющий структуру ответа об ошибке Azure Synapse.
RunFilterParameters	Параметры запроса для перечисления запусков.
RunQueryFilter	Параметр фильтра запросов для перечисления запусков.
RunQueryFilterOperand	Имя параметра, используемое для фильтрации. Допустимые операнды для выполнения конвейеров запросов: PipelineName, RunStart, RunEnd и Status; для выполнения действий запроса являются ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType и Status, а для запуска триггера запроса — TriggerName, TriggerRunTimestamp и Status.
RunQueryFilterOperator	Оператор, используемый для фильтрации.
RunQueryOrder	Порядок сортировки параметра.
RunQueryOrderBy	Объект, предоставляющий порядок по параметрам для перечисления запусков.
RunQueryOrderByField	Имя параметра, используемое для заказа. Допустимые параметры для выполнения конвейера: PipelineName, RunStart, RunEnd и Status; для выполнения действий являются ActivityName, ActivityRunStart, ActivityRunEnd и Status; для запусков триггеров являются TriggerName, TriggerRunTimestamp и Status.

ActivityRun

Object

Сведения о выполнении действия в конвейере.

Имя	Тип	Описание
activityName	string	Имя действия.
activityRunEnd	string (date-time)	Время окончания действия в формате ISO 8601.
activityRunId	string	Идентификатор выполнения действия.
activityRunStart	string (date-time)	Время начала действия в формате ISO 8601.
activityType	string	Тип действия.
durationInMs	integer	Длительность выполнения действия.
error	object	Ошибка при выполнении действия.
input	object	Входные данные для действия.
linkedServiceName	string	Имя связанной службы вычислений.
output	object	Выходные данные для действия.
pipelineName	string	Имя конвейера.
pipelineRunId	string	Идентификатор запуска конвейера.
status	string	Состояние выполнения действия.

ActivityRunsQueryResponse

Object

Выполняется действие списка.

Имя	Тип	Описание
continuationToken	string	Маркер продолжения для получения следующей страницы результатов, если все оставшиеся результаты существуют, значение NULL в противном случае.
value	ActivityRun[]	Список запусков действий.

CloudError

Object

Объект, определяющий структуру ответа об ошибке Azure Synapse.

Имя	Тип	Описание
error.code	string	Код ошибки.
error.details	CloudError[]	Массив с дополнительными сведениями об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Имя или путь свойства в запросе, связанном с ошибкой.

RunFilterParameters

Object

Параметры запроса для перечисления запусков.

Имя	Тип	Описание
continuationToken	string	Маркер продолжения для получения следующей страницы результатов. Null для первой страницы.
filters	RunQueryFilter[]	Список фильтров.
lastUpdatedAfter	string (date-time)	Время или после обновления события выполнения в формате ISO 8601.
lastUpdatedBefore	string (date-time)	Время или до обновления события выполнения в формате ISO 8601.
orderBy	RunQueryOrderBy[]	Список параметра OrderBy.

RunQueryFilter

Object

Параметр фильтра запросов для перечисления запусков.

Имя	Тип	Описание
operand	RunQueryFilterOperand	Имя параметра, используемое для фильтрации. Допустимые операнды для выполнения конвейеров запросов: PipelineName, RunStart, RunEnd и Status; для выполнения действий запроса являются ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType и Status, а для запуска триггера запроса — TriggerName, TriggerRunTimestamp и Status.
operator	RunQueryFilterOperator	Оператор, используемый для фильтрации.
values	string[]	Список значений фильтра.

RunQueryFilterOperand

Перечисление

Имя параметра, используемое для фильтрации. Допустимые операнды для выполнения конвейеров запросов: PipelineName, RunStart, RunEnd и Status; для выполнения действий запроса являются ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType и Status, а для запуска триггера запроса — TriggerName, TriggerRunTimestamp и Status.

Значение	Описание
PipelineName
Status
RunStart
RunEnd
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

Перечисление

Оператор, используемый для фильтрации.

Значение	Описание
Equals
NotEquals
In
NotIn

RunQueryOrder

Перечисление

Порядок сортировки параметра.

Значение	Описание
ASC
DESC

RunQueryOrderBy

Object

Объект, предоставляющий порядок по параметрам для перечисления запусков.

Имя	Тип	Описание
order	RunQueryOrder	Порядок сортировки параметра.
orderBy	RunQueryOrderByField	Имя параметра, используемое для заказа. Допустимые параметры для выполнения конвейера: PipelineName, RunStart, RunEnd и Status; для выполнения действий являются ActivityName, ActivityRunStart, ActivityRunEnd и Status; для запусков триггеров являются TriggerName, TriggerRunTimestamp и Status.

RunQueryOrderByField

Перечисление

Имя параметра, используемое для заказа. Допустимые параметры для выполнения конвейера: PipelineName, RunStart, RunEnd и Status; для выполнения действий являются ActivityName, ActivityRunStart, ActivityRunEnd и Status; для запусков триггеров являются TriggerName, TriggerRunTimestamp и Status.

Значение	Описание
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp

Поделиться через

Pipeline Run - Query Activity Runs

Параметры URI

Текст запроса

Ответы

Примеры

ActivityRuns_QueryByPipelineRun

Образец запроса

Пример ответа

Определения

ActivityRun

ActivityRunsQueryResponse

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField