แชร์ผ่าน

Workloads - List Workloads

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

แสดงปริมาณงานทั้งหมด เป็นทางเลือกที่กรองตามสถานะการกําหนด หากไม่ได้ระบุหรือตั้งค่า AssignStatus.Any ผลลัพธ์จะรวมปริมาณงานที่กําหนดและปริมาณงานที่ไม่ได้กําหนด
API นี้สนับสนุน การแบ่งหน้า

หมายเหตุ: จะมองเห็นได้เฉพาะปริมาณงานที่เผยแพร่เท่านั้น

การอนุญาต

ผู้เรียกต้องเป็นผู้ดูแลระบบ Fabric หรือรับรองความถูกต้องโดยใช้บริการหลัก

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

Tenant.Read.All หรือ Tenant.ReadWrite.All

ข้อจำกัด

สูงสุด 200 คําขอต่อชั่วโมง

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

API นี้สนับสนุน Microsoft identitiesที่ระบุในส่วนนี้

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

ส่วนติดต่อ

GET https://api.fabric.microsoft.com/v1/admin/workloads
ด้วยพารามิเตอร์ที่เลือกได้: 
GET https://api.fabric.microsoft.com/v1/admin/workloads?assignmentStatus={assignmentStatus}&continuationToken={continuationToken}

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

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

WorkloadAssignmentStatus

สถานะการกําหนดปริมาณงาน อาจมีการเพิ่มสถานะการกําหนดเพิ่มเติมเมื่อเวลาผ่านไป
continuationToken
 query

string

โทเค็นต่อเนื่อง ใช้เพื่อรับหน่วยข้อมูลถัดไปในรายการ

การตอบสนอง

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

WorkloadAssignmentInfos

ตกลง, ได้ การดําเนินการสําเร็จ
429 Too Many Requests

ErrorResponse

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

ส่วนหัว

Retry-After: integer
Other Status Codes

ErrorResponse

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

  • BadRequest - พารามิเตอร์คิวรีไม่ถูกต้อง

  • PrivateLinksUnsupported - ไม่รองรับ API ที่เปิดใช้งานลิงก์ส่วนตัว

  • ไม่ได้รับอนุญาต - ผู้เรียกไม่มีสิทธิ์ในการเรียกใช้ API

  • TooManyRequests - ผู้เรียกเกินจํานวนคําขอที่ได้รับอนุญาตในกรอบเวลาปัจจุบัน และคําขอเพิ่มเติมจะล้มเหลว

  • InternalServerError - ข้อผิดพลาดเซิร์ฟเวอร์ที่ไม่คาดคิด

ตัวอย่าง

List all workloads example
List workloads with assigned status example

List all workloads example

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

GET https://api.fabric.microsoft.com/v1/admin/workloads

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

รหัสสถานะ:
200 
{
  "value": [
    {
      "id": "Fabric.TestWorkload",
      "name": "Test Workload",
      "publisher": "Contoso",
      "isAssignable": true,
      "isAssignedToTenant": true,
      "assignedCapacitiesCount": 2,
      "assignedWorkspacesCount": 0
    },
    {
      "id": "Fabric.TestWorkloadV2",
      "name": "Awesome Workload",
      "publisher": "Contoso",
      "isAssignable": true,
      "isAssignedToTenant": false,
      "assignedCapacitiesCount": 0,
      "assignedWorkspacesCount": 0
    },
    {
      "id": "Fabric.SampleWorkload",
      "name": "Sample Workload",
      "publisher": "SampleOrganization",
      "isAssignable": true,
      "isAssignedToTenant": false,
      "assignedCapacitiesCount": 0,
      "assignedWorkspacesCount": 0
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

List workloads with assigned status example

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

GET https://api.fabric.microsoft.com/v1/admin/workloads?assignmentStatus=Assigned

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

รหัสสถานะ:
200 
{
  "value": [
    {
      "id": "Fabric.SampleWorkloadV2",
      "name": "Sample Workload",
      "publisher": "Contoso",
      "isAssignable": true,
      "isAssignedToTenant": true,
      "assignedCapacitiesCount": 2,
      "assignedWorkspacesCount": 3
    },
    {
      "id": "Fabric.TestWorkload",
      "name": "Test Workload",
      "publisher": "Contoso",
      "isAssignable": true,
      "isAssignedToTenant": true,
      "assignedCapacitiesCount": 0,
      "assignedWorkspacesCount": 0
    },
    {
      "id": "Org.TestWorkloadV2",
      "name": "Corp Workload",
      "publisher": "Corp",
      "isAssignable": false,
      "isAssignedToTenant": true,
      "assignedCapacitiesCount": 0,
      "assignedWorkspacesCount": 0
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workloads?assignmentStatus=assigned&continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

คำจำกัดความ

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

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

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

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

ข้อมูลการกําหนดปริมาณงาน ประกอบด้วยรายละเอียดเกี่ยวกับปริมาณงานและสถานะการกําหนดทั่วทั้งผู้เช่า ความจุ และพื้นที่ทํางาน
WorkloadAssignmentInfos

รายการที่มีการแบ่งหน้าของปริมาณงานในผู้เช่า ประกอบด้วยข้อมูลปริมาณงานที่มีรายละเอียดสถานะการกําหนด
WorkloadAssignmentStatus

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

ErrorRelatedResource

วัตถุ

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

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

string

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

string

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

ErrorResponse

วัตถุ

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string (uuid)

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

ErrorResponseDetails

วัตถุ

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

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

string

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

string

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

ErrorRelatedResource

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

WorkloadAssignmentInfo

วัตถุ

ข้อมูลการกําหนดปริมาณงาน ประกอบด้วยรายละเอียดเกี่ยวกับปริมาณงานและสถานะการกําหนดทั่วทั้งผู้เช่า ความจุ และพื้นที่ทํางาน

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

integer

จํานวนของความจุที่กําหนดปริมาณงาน
assignedWorkspacesCount

integer

จํานวนของพื้นที่ทํางานที่มีการกําหนดปริมาณงาน
id

string

ตัวระบุที่ไม่ซ้ํากันของปริมาณงาน
isAssignable

boolean

ระบุว่าปริมาณงานสามารถกําหนดได้หรือไม่ เมื่อเป็นจริง ปริมาณงานสามารถกําหนดให้กับผู้เช่า ความจุ หรือพื้นที่ทํางาน
isAssignedToTenant

boolean

ระบุว่าปริมาณงานถูกกําหนดให้กับขอบเขตผู้เช่าหรือไม่ เมื่อเป็นจริง ปริมาณงานจะพร้อมใช้งานทั่วทั้งผู้เช่า
name

string

ชื่อที่แสดงของปริมาณงาน
publisher

string

ผู้เผยแพร่ของปริมาณงาน

WorkloadAssignmentInfos

วัตถุ

รายการที่มีการแบ่งหน้าของปริมาณงานในผู้เช่า ประกอบด้วยข้อมูลปริมาณงานที่มีรายละเอียดสถานะการกําหนด

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

string

โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri

string

URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
value

WorkloadAssignmentInfo[]

รายการปริมาณงานที่มีข้อมูลการกําหนด

WorkloadAssignmentStatus

การแจงนับ

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

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

ปริมาณงานที่กําหนดหรือไม่ได้กําหนด
Assigned

ปริมาณงานที่กําหนดให้กับผู้เช่าหรือไปยังพื้นที่ทํางานหรือความจุในผู้เช่าอย่างน้อยหนึ่งรายการ
Unassigned

ปริมาณงานที่ไม่ได้กําหนดให้กับผู้เช่า พื้นที่ทํางาน หรือความจุใด ๆ ในผู้เช่า