ListRayCluster - E-MapReduce - Alibaba Cloud Documentation Center

Menampilkan daftar kluster Ray.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

emr-serverless-spark:ListRayCluster

none

*全部资源

*

None

Sintaks permintaan

GET /api/v1/workspaces/{workspaceId}/rayCluster HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	ID ruang kerja.	w-d2d82aa09155

Parameter permintaan

Parameter	Type	Required	Description	Example
pageSize	integer	No	Jumlah entri per halaman. Nilai default: 20. Nilai valid: 1 hingga 100.	20
pageNum	integer	No	Nomor halaman.	1

Elemen respons

Element	Type	Description	Example
	object	The response schema.
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944
rayClusters	array<object>	The list of Ray clusters.
	array<object>	The Ray cluster struct.
clusterId	string	The cluster ID.	ray-uiulpgow9xljimm1
name	string	The name of the Ray cluster.	testRayCluster
displayReleaseVersion	string	The Ray engine version.	ray-1.0.0 (Ray 2.47.1, Python 3.12)
description	string	The description.	Ray Cluster for dev.
networkServiceName	string	The name of the network connectivity service.	vpc
headSpec	object	The information about the head node of the Ray cluster.
queueName	string	The queue name.	root_queue
cpu	string	The number of CPU cores.	2
memory	string	The memory size. Unit: Gi.	8Gi
enableAutoScaling	boolean	Indicates whether automatic scaling is enabled for worker nodes.	false
idleTimeoutSeconds	integer	The idle timeout period for worker nodes.	60
replica	integer	The number of nodes.	1
gpuSpec	string		ecs.gn6i-c4g1.xlarge
workerSpec	array<object>	The information about the worker nodes of the Ray cluster.
	object	The struct of the worker node information for the Ray cluster.
groupName	string	The name of the worker group.	Group1
workerType	string	The worker type.	CPU
replica	integer	The number of nodes.	2
queueName	string	The queue name.	root_queue
cpu	string	The number of CPU cores.	2
memory	string	The memory size. Unit: Gi.	8Gi
minReplica	integer	The minimum number of worker nodes after automatic scaling is enabled.	1
maxReplica	integer	The maximum number of worker nodes after automatic scaling is enabled.	10
gpuSpec	string		ecs.gn6i-c4g1.xlarge
state	string	The cluster state. Starting: The cluster is starting. Running: The cluster is running. Stopping: The cluster is stopping. Stopped: The cluster is stopped. Error: The cluster has failed.	Running
createTime	integer	The time when the cluster was created.	1723722279800
modifiedTime	integer	The time when the cluster was last modified.	1723722279800
creator	string	The UID of the user who created the cluster.	202077646755123991
creatorName	string	The nickname of the creator.	Alice
modifier	string	The UID of the user who last updated the cluster.	202077646755123991
modifierName	string	The nickname of the modifier.	Alice
userId	string	The ID of the Alibaba Cloud account.	1234567890
dashboardUrl	string	The URL of the Ray cluster dashboard.	https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx
modified	boolean	Indicates whether the configuration has been modified.	false
message	string	The error message.	ok
instanceId	string	The ID of the Ray cluster instance.	ray-uiulpgow9xljimm1-xxxxxxx
startTime	integer	The startup time.	1723722279800
grpcEndpoint	string	The gRPC endpoint for the internal network. The domain name can also be used to submit Ray jobs.	ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80

Contoh

Respons sukses

JSONformat

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "rayClusters": [
    {
      "clusterId": "ray-uiulpgow9xljimm1",
      "name": "testRayCluster",
      "displayReleaseVersion": "ray-1.0.0 (Ray 2.47.1, Python 3.12)",
      "description": "Ray Cluster for dev.",
      "networkServiceName": "vpc",
      "headSpec": {
        "queueName": "root_queue",
        "cpu": "2",
        "memory": "8Gi",
        "enableAutoScaling": false,
        "idleTimeoutSeconds": 60,
        "replica": 1,
        "gpuSpec": "ecs.gn6i-c4g1.xlarge"
      },
      "workerSpec": [
        {
          "groupName": "Group1",
          "workerType": "CPU",
          "replica": 2,
          "queueName": "root_queue",
          "cpu": "2",
          "memory": "8Gi",
          "minReplica": 1,
          "maxReplica": 10,
          "gpuSpec": "ecs.gn6i-c4g1.xlarge"
        }
      ],
      "state": "Running",
      "createTime": 1723722279800,
      "modifiedTime": 1723722279800,
      "creator": "202077646755123991",
      "creatorName": "Alice",
      "modifier": "202077646755123991",
      "modifierName": "Alice",
      "userId": "1234567890",
      "dashboardUrl": "https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx",
      "modified": false,
      "message": "ok",
      "instanceId": "ray-uiulpgow9xljimm1-xxxxxxx",
      "startTime": 1723722279800,
      "grpcEndpoint": "ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.