แชร์ผ่าน

Background Jobs - Run On Demand Execute

บริการ:
Dataflow
เวอร์ชัน API:
v1

เรียกใช้อินสแตนซ์งานตามต้องการ

Note

API นี้เป็นส่วนหนึ่งของการเผยแพร่ตัวอย่าง และมีไว้เพื่อวัตถุประสงค์ในการประเมินและการพัฒนาเท่านั้น ซึ่งอาจเปลี่ยนแปลงตามคําติชมและไม่แนะนําสําหรับการใช้งานด้านการผลิต มีการอัปเดต URL สําหรับ API นี้เพื่อรวมประเภทงานเป็นส่วนหนึ่งของเส้นทางแทนที่การใช้ก่อนหน้าของพารามิเตอร์คิวรี สําหรับความเข้ากันได้ย้อนหลัง การเรียกใช้โดยใช้พารามิเตอร์คิวรีจะยังคงได้รับการสนับสนุน

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

สําหรับกระแสข้อมูล API ใช้ชนิดขอบเขตเหล่านี้:

  • ขอบเขตที่เฉพาะเจาะจง: Dataflow.Execute.All

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต โปรดดู: บทความขอบเขต

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

Identity Support
User Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ No

Interface

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

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
dataflowId
 path True

string (uuid)

ID กระแสข้อมูล
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

เนื้อความของคำขอ

ชื่อ พิมพ์ คำอธิบาย
executionData

DataflowExecutionPayload

ส่วนข้อมูลสําหรับการเรียกใช้คําของานตามความต้องการ จําเป็นเฉพาะในกรณีที่กระแสข้อมูลมีการเปิดใช้งานการกําหนดพารามิเตอร์

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
202 Accepted

คําขอที่ยอมรับ การดําเนินการงานกําลังอยู่ระหว่างดําเนินการ

ส่วนหัว

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

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • ไม่เพียงพอ Privileges - ผู้เรียกมีสิทธิ์การใช้งานเพียงพอในการเรียกใช้อินสแตนซ์ของงาน

  • 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/Execute/instances

คำตอบตัวอย่าง

รหัสสถานะ:
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/Execute/instances

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

คำจำกัดความ

ชื่อ คำอธิบาย
DataflowExecutionPayload

ส่วนข้อมูลการดําเนินการสําหรับกระแสข้อมูล
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
ExecuteOption

ตัวเลือกในการเรียกใช้การดําเนินการ อาจมีการเพิ่มการดําเนินการเพิ่มเติมเมื่อเวลาผ่านไป
ItemJobParameter

รายละเอียดพารามิเตอร์
RunOnDemandDataflowExecuteJobRequest

เรียกใช้ตามต้องการสําหรับส่วนข้อมูลของอินสแตนซ์ของงานกระแสข้อมูล
Type

ชนิดพารามิเตอร์ คุณสามารถเพิ่มชนิดพารามิเตอร์เพิ่มเติมเมื่อเวลาผ่านไป

DataflowExecutionPayload

วัตถุ

ส่วนข้อมูลการดําเนินการสําหรับกระแสข้อมูล

ชื่อ พิมพ์ คำอธิบาย
executeOption

ExecuteOption

ตัวเลือกในการเรียกใช้การดําเนินการ อาจมีการเพิ่มการดําเนินการเพิ่มเติมเมื่อเวลาผ่านไป
parameters

ItemJobParameter[]

รายการของพารามิเตอร์ที่จะแทนที่ระหว่างการดําเนินการ

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ExecuteOption

การแจงนับ

ตัวเลือกในการเรียกใช้การดําเนินการ อาจมีการเพิ่มการดําเนินการเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
SkipApplyChanges

ค่าเริ่มต้น การดําเนินการนําการเปลี่ยนแปลงไปใช้จะถูกข้ามไป
ApplyChangesIfNeeded

การดําเนินการเปลี่ยนแปลง Appply จะดําเนินการถ้าจําเป็น สามารถใช้เมื่อจําเป็นต้องมีการเปลี่ยนแปลงล่าสุดสําหรับดําเนินการ

ItemJobParameter

วัตถุ

รายละเอียดพารามิเตอร์

ชื่อ พิมพ์ คำอธิบาย
parameterName

string

ชื่อของพารามิเตอร์
type

Type

ชนิดพารามิเตอร์ คุณสามารถเพิ่มชนิดพารามิเตอร์เพิ่มเติมเมื่อเวลาผ่านไป
value

ค่าของพารามิเตอร์ที่จะแทนที่ระหว่างการดําเนินการ

RunOnDemandDataflowExecuteJobRequest

วัตถุ

เรียกใช้ตามต้องการสําหรับส่วนข้อมูลของอินสแตนซ์ของงานกระแสข้อมูล

ชื่อ พิมพ์ คำอธิบาย
executionData

DataflowExecutionPayload

ส่วนข้อมูลสําหรับการเรียกใช้คําของานตามความต้องการ จําเป็นเฉพาะในกรณีที่กระแสข้อมูลมีการเปิดใช้งานการกําหนดพารามิเตอร์

Type

การแจงนับ

ชนิดพารามิเตอร์ คุณสามารถเพิ่มชนิดพารามิเตอร์เพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Automatic

ค่าต้องเป็นอัตโนมัติ