Published - Get Spark Compute

บริการ:: Environment

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

รับการประมวลผลแบบประกายไฟของสภาพแวดล้อม

Note

API นี้เป็นเวอร์ชันเบต้ารุ่นเผยแพร่เนื่องจากเลิกใช้ในวันที่ 31 สิงหาคม 2026 เมื่อเรียกใช้ API นี้ - ผู้เรียกต้องตั้งค่าพารามิเตอร์ beta คิวรีเป็นค่า false

สิทธิ์

อ่านสิทธิ์สําหรับรายการสภาพแวดล้อม

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

Item.Read.All หรือ Item.ReadWrite.All หรือ Environment.Read.All หรือ Environment.ReadWrite.All

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

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

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

ส่วนติดต่อ

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?beta={beta}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
environmentId	path	True	string (uuid)	รหัสสภาพแวดล้อม
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
beta	query	True	boolean	พารามิเตอร์นี้ระบุเวอร์ชันของ API ที่จะใช้ ตั้งค่าเพื่อใช้ `false` เวอร์ชันที่วางจําหน่าย

การตอบสนอง

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

200 OK

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

EnvironmentSparkCompute

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

429 Too Many Requests

ErrorResponse

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

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

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

ตัวอย่าง

Get environment Spark compute example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?beta=false

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

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

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603",
    "maxClustersToHydrateLimit": 10
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2",
  "customLivePoolSupport": "Enabled",
  "customLivePoolSettings": {
    "maxClustersToHydrate": 4,
    "clusterIdleTimeout": "PT20M",
    "customLivePoolLifespan": "PT1H"
  }
}

คำจำกัดความ

ชื่อ	คำอธิบาย
CustomLivePoolSettings	การตั้งค่าการไฮเดรชั่นแบบพูลสดบนการคํานวณแบบประกายของสภาพแวดล้อม
CustomLivePoolSupport	ค่าสถานะควบคุมว่าการสนับสนุนกลุ่มการถ่ายทอดสดเปิดใช้งานอยู่หรือไม่ อาจมีการเพิ่มค่าเพิ่มเติม `CustomLivePoolSupport` เมื่อเวลาผ่านไป
CustomPoolMemory	หน่วยความจําพูลแบบกําหนดเองสําหรับโปรแกรมควบคุม Spark หรือ Spark executor ประเภท `CustomPoolMemory` เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
CustomPoolType	ชนิดกลุ่มที่กําหนดเอง ประเภท `CustomPoolType` เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
DynamicExecutorAllocationProperties	proerties การปันส่วนผู้ปฏิบัติการแบบไดนามิก
EnvironmentSparkCompute
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
InstancePool	พูลอินสแตนซ์
SparkProperty	คีย์คุณสมบัติ Spark และค่า

CustomLivePoolSettings

วัตถุ

การตั้งค่าการไฮเดรชั่นแบบพูลสดบนการคํานวณแบบประกายของสภาพแวดล้อม

ชื่อ	พิมพ์	คำอธิบาย
clusterIdleTimeout	string (duration)	ค่าเกณฑ์เวลาที่ไม่ได้ใช้งานหลังจากที่มีการปล่อยคลัสเตอร์ที่มีการไฮเดรตโดยใช้รูปแบบระยะเวลา ISO 8601 ต่ําสุด: PT20M สูงสุด: PT24H
customLivePoolLifespan	string (duration)	อายุการใช้งานสูงสุดของการเปิดใช้งานพูลสด โดยใช้รูปแบบระยะเวลา ISO 8601 งานพูลสดจะทํางานสําหรับระยะเวลานี้แล้วสิ้นสุด ต่ําสุด: PT30M สูงสุด: PT24H
maxClustersToHydrate	integer (int32) minimum: 1	จํานวนสูงสุดของคลัสเตอร์ที่จะไฮเดรตก่อนในระหว่างรอบการเปิดใช้งานแต่ละครั้ง ต่ําสุด: 1 ค่าที่อนุญาตสูงสุดจะถูกกําหนดโดยขนาดความจุและจะแสดงบนการตั้งค่ากลุ่มอินสแตนซ์เป็น`InstancePool.maxClustersToHydrateLimit`

CustomLivePoolSupport

การแจงนับ

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

ค่า	คำอธิบาย
Enabled	การสนับสนุนสระว่ายน้ําสดเปิดใช้งานอยู่
Disabled	การสนับสนุนสระว่ายน้ําสดไม่ได้ใช้งาน การกําหนดค่าถูกเก็บไว้

CustomPoolMemory

การแจงนับ

หน่วยความจําพูลแบบกําหนดเองสําหรับโปรแกรมควบคุม Spark หรือ Spark executor ประเภท CustomPoolMemory เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
28g	หน่วยความจํา 28GB
56g	หน่วยความจํา 56G
112g	หน่วยความจํา 112G
224g	หน่วยความจํา 224G
400g	หน่วยความจํา 400G

CustomPoolType

การแจงนับ

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

ค่า	คำอธิบาย
Workspace	กลุ่มแบบกําหนดเองระดับพื้นที่ทํางาน
Capacity	กลุ่มที่กําหนดเองของระดับกําลังการผลิต

DynamicExecutorAllocationProperties

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
enabled	boolean	สถานะของการปันส่วนผู้ปฏิบัติการแบบไดนามิก False - ปิดใช้งาน จริง - เปิดใช้งาน
maxExecutors	integer (int32) minimum: 1	หมายเลขตัวดําเนินการสูงสุดสําหรับการปันส่วนแบบไดนามิกและค่าต่ําสุดสําหรับคุณสมบัตินี้คือ 1 ค่าสูงสุดต้องต่ํากว่ากลุ่ม `maxNodeCount`อินสแตนซ์
minExecutors	integer (int32) minimum: 1	หมายเลขตัวดําเนินการต่ําสุดสําหรับการปันส่วนแบบไดนามิกและค่าต่ําสุดสําหรับคุณสมบัตินี้คือ 1 ค่าสูงสุดจะต้องต่ํากว่า`maxExecutors`

EnvironmentSparkCompute

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
customLivePoolSettings	CustomLivePoolSettings	การตั้งค่าการไฮเดรชั่นของสระว่ายน้ําสด ควบคุมวิธีการเปิดใช้งานการไฮเดรทคลัสเตอร์ไว้ล่วงหน้าเมื่อเปิดใช้งานการสนับสนุนการสตรีมสด
customLivePoolSupport	CustomLivePoolSupport	ควบคุมว่าเปิดใช้งานกลุ่มการถ่ายทอดสดหรือไม่ เมื่อ `Enabled`, คลัสเตอร์ได้รับการไฮเดรทล่วงหน้าตามการตั้งค่าการให้ความชุ่มชื้นเพื่อให้ปริมาณงานเริ่มต้นโดยไม่มีเวลาแฝงในการเริ่มต้นที่เย็น
driverCores	integer (int32)	แกนคนขับ Spark ต้องเป็นหนึ่งในค่าต่อไปนี้: 4, 8, 16, 32, 64
driverMemory	CustomPoolMemory	หน่วยความจําโปรแกรมควบคุม Spark
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	การปันส่วนผู้ปฏิบัติการแบบไดนามิก
executorCores	integer (int32)	แกนประมวลผล Spark ต้องเป็นหนึ่งในค่าต่อไปนี้: 4, 8, 16, 32, 64
executorMemory	CustomPoolMemory	หน่วยความจําเครื่องปฏิบัติการ Spark
instancePool	InstancePool	พูลสภาพแวดล้อมต้องเป็นพูลแบบกําหนดเองที่ถูกต้อง "Starter Pool" หมายถึงใช้พูลตัวเริ่มต้น
runtimeVersion	string	เวอร์ชันรันไทม์ ค้นหา รันไทม์ผ้าที่รองรับ ตัวอย่างเช่น: 1.3
sparkProperties	SparkProperty[]	คุณสมบัติ Spark

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	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

InstancePool

วัตถุ

พูลอินสแตนซ์

ชื่อ	พิมพ์	คำอธิบาย
id	string (uuid)	รหัสกลุ่มอินสแตนซ์
maxClustersToHydrateLimit	integer (int32)	ขอบสูงสุดที่คํานวณโดยเซิร์ฟเวอร์สําหรับการตั้งค่าพูล `maxClustersToHydrate` สด โดยพิจารณาจากขนาดความจุที่เชื่อมโยงกับพูลนี้
name	string	ชื่อพูลอินสแตนซ์
type	CustomPoolType	ชนิดพูลอินสแตนซ์

SparkProperty

วัตถุ

คีย์คุณสมบัติ Spark และค่า

ชื่อ	พิมพ์	คำอธิบาย
key	string	คีย์คุณสมบัติ Spark
value	string	ค่าคุณสมบัติ Spark