Activity Runs - Query By Pipeline Run

  • 참조
Service:
Data Factory
API Version:
2018-06-01

쿼리 활동은 입력 필터 조건에 따라 실행됩니다.

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

URI 매개 변수

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

string

팩터리 이름입니다.

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

string

리소스 그룹 이름입니다.

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

string

파이프라인 실행 식별자입니다.
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

ActivityRunsQueryResponse

OK.
Other Status Codes

CloudError

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

보안

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

ActivityRuns_QueryByPipelineRun

Sample Request

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

Sample Response

Status code:
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
Response Body
{
  "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"
    }
  ]
}

정의

Name Description
ActivityRun

파이프라인에서 실행되는 활동에 대한 정보입니다.
ActivityRunsQueryResponse

목록 활동이 실행됩니다.
CloudError

Azure Data Factory 오류 응답의 구조를 정의하는 개체입니다.
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

파이프라인에서 실행되는 활동에 대한 정보입니다.

Name 형식 Description
activityName

string

작업의 이름입니다.
activityRunEnd

string

활동의 종료 시간은 'ISO 8601' 형식으로 실행됩니다.
activityRunId

string

활동 실행의 ID입니다.
activityRunStart

string

활동의 시작 시간은 'ISO 8601' 형식으로 실행됩니다.
activityType

string

작업 형식입니다.
durationInMs

integer

활동 실행 기간입니다.
error

object

작업 실행 중 오류가 있는 경우 입니다.
input

object

활동에 대한 입력입니다.
linkedServiceName

string

컴퓨팅 연결된 서비스의 이름입니다.
output

object

활동의 출력입니다.
pipelineName

string

파이프라인의 이름
pipelineRunId

string

파이프라인 실행의 ID입니다.
status

string

작업 실행의 상태.

ActivityRunsQueryResponse

목록 활동이 실행됩니다.

Name 형식 Description
continuationToken

string

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

ActivityRun[]

활동 실행 목록입니다.

CloudError

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

Name 형식 Description
error.code

string

오류 코드
error.details

CloudError[]

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

string

오류 메시지입니다.
error.target

string

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

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