Long Running Operations - Get Operation State

บริการ:: Core

เวอร์ชัน API:: v1

แสดงสถานะปัจจุบันของการดําเนินการเรียกใช้ที่นาน
คุณได้รับ operationId จาก x-ms-operation-id header ที่ส่งกลับโดย API ที่เริ่มต้นการดําเนินการ เมื่อสถานะการดําเนินการเป็น 'สําเร็จ' ให้ใช้ API รับผลลัพธ์การดําเนินการ เพื่อดึงข้อมูลผลลัพธ์

Permissions

เช่นเดียวกับสิทธิ์ที่จําเป็นสําหรับ API ที่เริ่มต้นการดําเนินการ

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

เหมือนกับขอบเขตที่จําเป็นสําหรับ API ที่เริ่มต้นการดําเนินการ

ขีดจํากัดการควบคุม

ประเภทขีดจํากัด	ค่า
โควตาแบบครบวงจรสําหรับ API การดําเนินงาน Long-Running	โทร 200 ครั้ง/นาที
ขีดจํากัด API	โทร 200 ครั้ง/นาที

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

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

เอกลักษณ์	การสนับสนุน
ผู้ใช้	ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	ใช่

อินเตอร์เฟซ

GET https://api.fabric.microsoft.com/v1/operations/{operationId}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
operationId	path	True	string (uuid)	รหัสการดําเนินงาน

การตอบสนอง

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

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	OperationState	คําขอเสร็จสมบูรณ์ ส่วนหัว Location: string Retry-After: integer x-ms-operation-id: string
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: UnknownError - เกิดข้อผิดพลาด

OperationState

คําขอเสร็จสมบูรณ์

ส่วนหัว

Location: string
Retry-After: integer
x-ms-operation-id: string

429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

UnknownError - เกิดข้อผิดพลาด

ตัวอย่าง

Get active long running operation example

Get completed long running operation example

Get active long running operation example

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

HTTP

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

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

รหัสสถานะ:: 200

Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 20

{
  "status": "Running",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 25
}

Get completed long running operation example

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

HTTP

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

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

รหัสสถานะ:: 200

Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227/result
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227

{
  "status": "Succeeded",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 100
}

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
LongRunningOperationStatus	สถานะปัจจุบันของการดําเนินงาน อาจมีการเพิ่มสถานะการดําเนินการเพิ่มเติมเมื่อเวลาผ่านไป
OperationState	วัตถุที่อธิบายรายละเอียดและสถานะปัจจุบันของการดําเนินการที่ใช้เวลานาน

ErrorRelatedResource

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

LongRunningOperationStatus

การแจงนับ

สถานะปัจจุบันของการดําเนินงาน อาจมีการเพิ่มสถานะการดําเนินการเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Undefined	ไม่ได้กําหนดสถานะของการดําเนินงาน
NotStarted	การดําเนินการไม่เริ่มขึ้น
Running	การดําเนินการกําลังทํางานอยู่
Succeeded	การดําเนินงานเสร็จสิ้นแล้ว
Failed	การดําเนินการล้มเหลว

OperationState

วัตถุ

วัตถุที่อธิบายรายละเอียดและสถานะปัจจุบันของการดําเนินการที่ใช้เวลานาน

ชื่อ	พิมพ์	คำอธิบาย
createdTimeUtc	string (date-time)	วันที่และเวลาเริ่มต้นของการดําเนินงาน
error	ErrorResponse	รายละเอียดข้อผิดพลาดในกรณีที่การดําเนินการอยู่ในสถานะล้มเหลว
lastUpdatedTimeUtc	string (date-time)	วันที่และเวลาของการเปลี่ยนแปลงการดําเนินงานครั้งล่าสุด
percentComplete	integer (int32) minimum: 0 maximum: 100	ความคืบหน้าของการดําเนินการเป็นเปอร์เซ็นต์
status	LongRunningOperationStatus	สถานะปัจจุบันของการดําเนินงาน อาจมีการเพิ่มสถานะการดําเนินการเพิ่มเติมเมื่อเวลาผ่านไป