다음을 통해 공유


Pipeline Runs - Query By Factory

쿼리 파이프라인은 입력 필터 조건에 따라 팩터리에서 실행됩니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
factoryName
path True

string

팩터리 이름입니다.

regex 패턴: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

리소스 그룹 이름입니다.

regex 패턴: ^[-\w\._\(\)]+$

subscriptionId
path True

string

구독 식별자입니다.

api-version
query True

string

API 버전입니다.

요청 본문

Name 필수 형식 Description
lastUpdatedAfter True

string

실행 이벤트가 'ISO 8601' 형식으로 업데이트된 시간 또는 그 이후입니다.

lastUpdatedBefore True

string

실행 이벤트가 'ISO 8601' 형식으로 업데이트된 시간 또는 이전 시간입니다.

continuationToken

string

결과의 다음 페이지를 가져오기 위한 연속 토큰입니다. 첫 번째 페이지의 경우 Null입니다.

filters

RunQueryFilter[]

필터 목록입니다.

orderBy

RunQueryOrderBy[]

OrderBy 옵션 목록입니다.

응답

Name 형식 Description
200 OK

PipelineRunsQueryResponse

OK.

Other Status Codes

CloudError

Azure Data Factory 서비스에서 받은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

PipelineRuns_QueryByFactory

샘플 요청

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/queryPipelineRuns?api-version=2018-06-01

{
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
  "filters": [
    {
      "operand": "PipelineName",
      "operator": "Equals",
      "values": [
        "examplePipeline"
      ]
    }
  ]
}

샘플 응답

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
{
  "value": [
    {
      "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "pipelineName": "examplePipeline",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "invokedBy": {
        "id": "80a01654a9d34ad18b3fcac5d5d76b67",
        "name": "Manual"
      },
      "runStart": "2018-06-16T00:37:44.6257014Z",
      "runEnd": "2018-06-16T00:38:12.7314495Z",
      "durationInMs": 28105,
      "status": "Succeeded",
      "message": "",
      "lastUpdated": "2018-06-16T00:38:12.7314495Z",
      "annotations": [],
      "runDimension": {
        "JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3"
      }
    },
    {
      "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
      "pipelineName": "examplePipeline",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "invokedBy": {
        "id": "7c5fd7ef7e8a464b98b931cf15fcac66",
        "name": "Manual"
      },
      "runStart": "2018-06-16T00:39:49.2745128Z",
      "runEnd": null,
      "durationInMs": null,
      "status": "Cancelled",
      "message": "",
      "lastUpdated": "2018-06-16T00:39:51.216097Z",
      "annotations": [],
      "runDimension": {
        "JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab"
      }
    }
  ]
}

정의

Name Description
CloudError

Azure Data Factory 오류 응답의 구조를 정의하는 개체입니다.

PipelineRun

파이프라인 실행에 대한 정보입니다.

PipelineRunInvokedBy

파이프라인 실행을 시작한 엔터티 이름과 ID를 제공합니다.

PipelineRunsQueryResponse

목록 파이프라인이 실행됩니다.

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입니다.

CloudError

Azure Data Factory 오류 응답의 구조를 정의하는 개체입니다.

Name 형식 Description
error.code

string

오류 코드

error.details

CloudError[]

추가 오류 세부 정보가 있는 배열입니다.

error.message

string

오류 메시지입니다.

error.target

string

오류와 관련된 요청의 속성 이름/경로입니다.

PipelineRun

파이프라인 실행에 대한 정보입니다.

Name 형식 Description
durationInMs

integer

파이프라인 실행 기간입니다.

invokedBy

PipelineRunInvokedBy

파이프라인 실행을 시작한 엔터티입니다.

isLatest

boolean

복구된 파이프라인 실행이 해당 그룹의 최신 실행인지를 나타냅니다.

lastUpdated

string

파이프라인 실행 이벤트에 대해 마지막으로 업데이트된 타임스탬프(ISO8601 형식)입니다.

message

string

파이프라인 실행의 메시지입니다.

parameters

object

파이프라인 실행에 사용되는 매개 변수 이름, 값 쌍의 전체 또는 부분 목록입니다.

pipelineName

string

파이프라인 이름입니다.

runDimensions

object

파이프라인 실행에서 내보낸 차원을 실행합니다.

runEnd

string

파이프라인 실행의 종료 시간은 ISO8601 형식입니다.

runGroupId

string

파이프라인 실행의 모든 복구 실행의 상관 관계를 지정하는 식별자입니다.

runId

string

실행의 식별자입니다.

runStart

string

파이프라인 실행의 시작 시간은 ISO8601 형식입니다.

status

string

파이프라인 실행의 상태. 가능한 값: Queued, InProgress, Succeeded, Failed, Canceling, Canceled

PipelineRunInvokedBy

파이프라인 실행을 시작한 엔터티 이름과 ID를 제공합니다.

Name 형식 Description
id

string

실행을 시작한 엔터티의 ID입니다.

invokedByType

string

실행을 시작한 엔터티의 형식입니다.

name

string

파이프라인 실행을 시작한 엔터티의 이름입니다.

pipelineName

string

실행을 트리거한 파이프라인의 이름(있는 경우)입니다.

pipelineRunId

string

실행을 트리거한 파이프라인의 실행 ID(있는 경우)입니다.

PipelineRunsQueryResponse

목록 파이프라인이 실행됩니다.

Name 형식 Description
continuationToken

string

결과의 다음 페이지를 가져오기 위한 연속 토큰이며, 나머지 결과가 있는 경우 null이면 입니다.

value

PipelineRun[]

파이프라인 실행 목록입니다.

RunFilterParameters

실행을 나열하기 위한 쿼리 매개 변수입니다.

Name 형식 Description
continuationToken

string

결과의 다음 페이지를 가져오기 위한 연속 토큰입니다. 첫 번째 페이지의 경우 Null입니다.

filters

RunQueryFilter[]

필터 목록입니다.

lastUpdatedAfter

string

실행 이벤트가 'ISO 8601' 형식으로 업데이트된 시간 또는 그 이후입니다.

lastUpdatedBefore

string

실행 이벤트가 'ISO 8601' 형식으로 업데이트된 시간 또는 이전 시간입니다.

orderBy

RunQueryOrderBy[]

OrderBy 옵션 목록입니다.

RunQueryFilter

실행을 나열하기 위한 쿼리 필터 옵션입니다.

Name 형식 Description
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입니다.

Name 형식 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

필터에 사용할 연산자입니다.

Name 형식 Description
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

매개 변수의 정렬 순서입니다.

Name 형식 Description
ASC

string

DESC

string

RunQueryOrderBy

실행을 나열하기 위한 옵션별로 순서를 제공할 개체입니다.

Name 형식 Description
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입니다.

Name 형식 Description
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string