แชร์ผ่าน

Custom Pools - List Workspace Custom Pools

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

แสดงรายการกลุ่มแบบกําหนดเอง

สิทธิ์

ผู้เรียกต้องมีบทบาท ของผู้ชม หรือสูงกว่าพื้นที่ทํางาน

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

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

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

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

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

อินเตอร์เฟซ

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

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

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

string (uuid)

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

string

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

การตอบสนอง

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

CustomPools

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

ErrorResponse

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

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

ตัวอย่าง

List custom pools example
List custom pools with continuation example

List custom pools example

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

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

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

รหัสสถานะ:
200 
{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Starter Pool",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Medium",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 10
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 9
      }
    },
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ]
}

List custom pools with continuation example

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

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

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

รหัสสถานะ:
200 
{
  "value": [
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools?continuationToken=LDEsMTAwMDAwLDA%3D"
}

คำจำกัดความ

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

คุณสมบัติการปรับขนาดอัตโนมัติ
CustomPool

กลุ่มแบบกําหนดเอง
CustomPools
CustomPoolType

ชนิดกลุ่มที่กําหนดเอง ประเภท CustomPoolType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
DynamicExecutorAllocationProperties

proerties การปันส่วนผู้ปฏิบัติการแบบไดนามิก
ErrorRelatedResource

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

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

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

ตระกูลโหนด ประเภท NodeFamily เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
NodeSize

ขนาดโหนด ประเภท NodeSize เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

AutoScaleProperties

ออบเจ็กต์

คุณสมบัติการปรับขนาดอัตโนมัติ

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

boolean

สถานะของมาตราส่วนอัตโนมัติ False - ปิดใช้งาน จริง - เปิดใช้งาน
maxNodeCount

integer (int32)

minimum: 1

จํานวนโหนดสูงสุด
minNodeCount

integer (int32)

minimum: 1

จํานวนโหนดต่ําสุด

CustomPool

ออบเจ็กต์

กลุ่มแบบกําหนดเอง

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

AutoScaleProperties

ปรับขนาดอัตโนมัติ
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

การปันส่วนผู้ปฏิบัติการแบบไดนามิก
id

string (uuid)

รหัสกลุ่มแบบกําหนดเอง
name

string

ชื่อกลุ่มแบบกําหนดเอง
nodeFamily

NodeFamily

ตระกูลโหนด
nodeSize

NodeSize

ขนาดโหนด
type

CustomPoolType

ชนิดกลุ่มที่กําหนดเอง

CustomPools

ออบเจ็กต์
ชื่อ พิมพ์ คำอธิบาย
continuationToken

string

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

string

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

CustomPool[]

รายการกลุ่มแบบกําหนดเอง

CustomPoolType

การแจงนับ

ชนิดกลุ่มที่กําหนดเอง ประเภท CustomPoolType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

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

กลุ่มแบบกําหนดเองระดับพื้นที่ทํางาน
Capacity

กลุ่มที่กําหนดเองของระดับกําลังการผลิต

DynamicExecutorAllocationProperties

ออบเจ็กต์

proerties การปันส่วนผู้ปฏิบัติการแบบไดนามิก

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

boolean

สถานะของการปันส่วนผู้ปฏิบัติการแบบไดนามิก False - ปิดใช้งาน จริง - เปิดใช้งาน
maxExecutors

integer (int32)

minimum: 1

ตัวดําเนินการสูงสุด
minExecutors

integer (int32)

minimum: 1

ตัวปฏิบัติการขั้นต่ํา

ErrorRelatedResource

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponse

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

ออบเจ็กต์

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

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

string

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

string

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

ErrorRelatedResource

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

NodeFamily

การแจงนับ

ตระกูลโหนด ประเภท NodeFamily เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

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

ปรับหน่วยความจําให้เหมาะสมแล้ว

NodeSize

การแจงนับ

ขนาดโหนด ประเภท NodeSize เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

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

โหนดขนาดเล็ก
Medium

ขนาดโหนดขนาดกลาง
Large

โหนดขนาดใหญ่ขนาด
XLarge

ขนาดโหนด XLarge
XXLarge

ขนาดโหนด XXLarge