다음을 통해 공유

Background Jobs - Run On Demand Execute

  • 참조
서비스:
Dataflow
API 버전:
v1

비고

이 API는 미리 보기로 제공됩니다.

주문형 실행 작업 인스턴스를 실행합니다.

필요한 위임된 범위

데이터 흐름의 경우 API는 다음 범위 유형을 사용합니다.

  • 특정 범위: Dataflow.Execute.All

범위에 대한 자세한 내용은 다음을 참조하세요. 범위 문서.

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티 지원
사용자 예
서비스 주체 및 관리 ID 아니오

인터페이스

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/instances?jobType={jobType}

URI 매개 변수

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

string (uuid)

데이터 흐름 ID입니다.
workspaceId
 path True

string (uuid)

작업 영역 ID입니다.
jobType
 query True

string

작업 유형을 실행합니다. 새로 고침 은 Execute의 별칭으로도 사용할 수 있습니다.

요청 본문

Name 형식 Description
executionData

DataflowExecutionPayload

주문형 실행 작업 요청에 대한 페이로드입니다. 데이터 흐름에 매개 변수화가 사용하도록 설정된 경우에만 필요합니다.

응답

Name 형식 Description
202 Accepted

요청이 수락되고 작업 실행이 진행 중입니다.

헤더

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • InsufficientPrivileges - 호출자에게 작업 인스턴스를 실행할 수 있는 충분한 권한이 없습니다.

  • InvalidJobType - 요청된 작업 유형이 잘못되었습니다.

  • TooManyRequestsForJobs - 호출자가 너무 많은 주문형 작업 요청을 요청합니다.

  • ItemNotFound - 요청된 항목 ID를 찾을 수 없습니다.

예제

Run dataflow Execute job instance with no request body example
Run dataflow Execute job instance with request body containing parameters example

Run dataflow Execute job instance with no request body example

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute

샘플 응답

상태 코드:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Run dataflow Execute job instance with request body containing parameters example

샘플 요청

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute

{
  "executionData": {
    "executeOption": "ApplyChangesIfNeeded",
    "parameters": [
      {
        "parameterName": "OrderKey",
        "type": "Automatic",
        "value": 25
      },
      {
        "parameterName": "Threshold",
        "type": "Automatic",
        "value": "start"
      }
    ]
  }
}

샘플 응답

상태 코드:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

정의

Name Description
DataflowExecutionPayload

데이터 흐름에 대한 실행 데이터 페이로드
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse

오류 응답입니다.
ErrorResponseDetails

오류 응답 세부 정보입니다.
ExecuteOption

실행 작업을 실행하는 옵션입니다. 시간이 지남에 따라 추가 executeOptions를 추가할 수 있습니다.
ItemJobParameter

매개 변수 세부 정보입니다.
RunOnDemandDataflowExecuteJobRequest

주문형 실행 데이터 흐름 작업 인스턴스 페이로드 실행
Type

매개 변수 형식입니다. 시간이 지남에 따라 추가 매개 변수 형식을 추가할 수 있습니다.

DataflowExecutionPayload

Object

데이터 흐름에 대한 실행 데이터 페이로드

Name 형식 Description
executeOption

ExecuteOption

실행 작업을 실행하는 옵션입니다. 시간이 지남에 따라 추가 executeOptions를 추가할 수 있습니다.
parameters

ItemJobParameter[]

실행 중에 재정의할 매개 변수 목록입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.
resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.
requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

ExecuteOption

열거형

실행 작업을 실행하는 옵션입니다. 시간이 지남에 따라 추가 executeOptions를 추가할 수 있습니다.

값 Description
ApplyChangesIfNeeded

필요한 경우 Appply 변경 작업이 수행됩니다. Execute에 최신 변경이 필요한 경우 사용할 수 있습니다.
SkipApplyChanges

기본값입니다. 변경 내용 적용 작업을 건너뜁습니다.

ItemJobParameter

Object

매개 변수 세부 정보입니다.

Name 형식 Description
parameterName

string

매개 변수의 이름입니다.
type

Type

매개 변수 형식입니다. 시간이 지남에 따라 추가 매개 변수 형식을 추가할 수 있습니다.
value

실행 중에 재정의할 매개 변수의 값입니다.

RunOnDemandDataflowExecuteJobRequest

Object

주문형 실행 데이터 흐름 작업 인스턴스 페이로드 실행

Name 형식 Description
executionData

DataflowExecutionPayload

주문형 실행 작업 요청에 대한 페이로드입니다. 데이터 흐름에 매개 변수화가 사용하도록 설정된 경우에만 필요합니다.

Type

열거형

매개 변수 형식입니다. 시간이 지남에 따라 추가 매개 변수 형식을 추가할 수 있습니다.

값 Description
Automatic

값은 자동이어야 합니다.