DescribeDBResourceGroup - AnalyticDB

Mengambil informasi resource group untuk sebuah kluster.

Deskripsi operasi

Untuk endpoint akses layanan ini, lihat Service endpoints.

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

adb:DescribeDBResourceGroup

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster Edisi Data Lakehouse.	amv-bp11q28kvl688****
GroupName	string	No	Nama resource group. Catatan Jika Anda tidak menentukan parameter ini, sistem akan mengembalikan informasi semua resource group dalam kluster yang ditentukan secara default.	test_group
GroupType	string	No	Tipe resource group. Nilai yang valid: Interactive Job Catatan Untuk informasi lebih lanjut mengenai resource group Edisi Data Lakehouse, lihat Resource Group Overview.	Job
RegionId	string	No	ID wilayah. Catatan Panggil operasi DescribeRegions untuk menanyakan ID wilayah kluster.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo	array<object>	Daftar informasi kelompok sumber daya.
	array<object>	Daftar informasi kelompok sumber daya.
GroupType	string	Tipe kelompok sumber daya. Nilai yang valid: Interactive Job Catatan Untuk informasi selengkapnya mengenai kelompok sumber daya Edisi Data Lakehouse, lihat Ikhtisar Kelompok Sumber Daya (Edisi Data Lakehouse).	Job
GroupName	string	Nama kelompok sumber daya.	test1
MinComputeResource	string	Sumber daya komputasi minimum yang dicadangkan, dalam satuan ACU.	0ACU
MaxComputeResource	string	Sumber daya komputasi maksimum yang dicadangkan, dalam satuan ACU.	512ACU
ClusterSizeResource	string	Parameter cadangan. Tidak berlaku.	预留参数，不涉及
MinClusterCount	integer	Parameter cadangan. Tidak berlaku.	预留参数，不涉及
MaxClusterCount	integer	Parameter cadangan. Tidak berlaku.	预留参数，不涉及
RunningClusterCount	integer	Parameter cadangan. Tidak berlaku.	预留参数，不涉及
ClusterMode	string	Parameter cadangan. Tidak berlaku.	预留参数，不涉及
ElasticMinComputeResource	string	Sumber daya komputasi elastis minimum, dalam satuan ACU.	16ACU
EnableSpot	string	Menunjukkan apakah fitur spot instance diaktifkan untuk kelompok sumber daya tersebut. Jika Anda mengaktifkan fitur spot instance, harga satuan sumber daya akan berkurang, tetapi sumber daya tersebut dapat dilepas. Nilai yang valid: True: Mengaktifkan fitur spot instance. False: Menonaktifkan fitur spot instance. Hanya kelompok sumber daya tipe Job yang dapat diatur ke True.	True
GroupUsers	string	Pengguna RAM yang ditautkan ke kelompok sumber daya.	testb,testc
CreateTime	string	Waktu pembuatan kelompok sumber daya. Waktu dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.	2022-08-29T03:34:30Z
UpdateTime	string	Waktu pembaruan. Waktu dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.	2022-08-31T03:34:30Z
Status	string	Status kelompok sumber daya. Nilai yang valid: creating: Sedang membuat ok: Telah dibuat pendingdelete: Menunggu penghapusan	ok
Rules	array<object>	Aturan pengiriman pekerjaan.
	object	Daftar informasi aturan.
GroupName	string	Nama kelompok sumber daya.	user_default
QueryTime	string	Ambang batas waktu eksekusi kueri, dalam milidetik (ms).	180000
TargetGroupName	string	Nama kelompok sumber daya target.	job
Engine	string
Message	string
AutoStopInterval	string
SpecName	string
TargetResourceGroupName	string
MinGpuQuantity	integer
MaxGpuQuantity	integer
RayConfig	object
EnableUserEni	boolean
HeadSpecType	string
HeadSpec	string
HeadAllocateUnit	string
HeadDiskCapacity	string
Category	string
WorkerGroups	array<object>	Daftar kelompok Ray Worker.
	object
GroupName	string	Nama kelompok Ray Worker.	g01
AllocateUnit	string	Unit alokasi.	1
MaxWorkerQuantity	integer	Jumlah maksimum Worker.	1
MinWorkerQuantity	integer	Jumlah minimum Worker.	1
WorkerDiskCapacity	string	Ukuran disk setiap Worker.	100G
WorkerSpecName	string	Tipe sumber daya Worker.	large
WorkerSpecType	string	Tipe sumber daya Ray Worker.	CPU
RayClusterAddress	string	Alamat kluster Ray.	http://ray-cluster-address.example.com
RayDashboardAddress	string	Alamat Ray Dashboard.	http://ray-dashboard-address.example.com
RayGrafanaAddress	string	Alamat Ray Grafana.	http://ray-grafana-address.example.com
AppConfig	object	Konfigurasi aplikasi Ray.
AppName	string	Nama aplikasi Ray.	app01
AppType	string	Tipe aplikasi Ray.	IsaacLab
ImageSelector	object	Konfigurasi image.
Image	string	Image.	lab2.10.0-ray2.43.0
InferenceEngine	string	Mesin inferensi.	vLLM
LlmModel	string	Model LLM.	Deepseek-R1
StorageMounts	array<object>	Daftar penyimpanan yang dipasang.
	object	Penyimpanan yang dipasang.
StorageId	integer	ID penyimpanan.	1
MountPath	string	Jalur pemasangan.	/mnt/data01
GpuElasticPlan	object
Enabled	boolean
Rules	array<object>
	object
StartCronExpression	string
EndCronExpression	string
ScalePolicy	string
Classification	string
EngineParams	object	Parameter engine.
	any	Parameter engine.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "预留参数，不涉及",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "预留参数，不涉及",
      "ElasticMinComputeResource": "16ACU",
      "EnableSpot": "True",
      "GroupUsers": "testb,testc",
      "CreateTime": "2022-08-29T03:34:30Z",
      "UpdateTime": "2022-08-31T03:34:30Z",
      "Status": "ok",
      "Rules": [
        {
          "GroupName": "user_default",
          "QueryTime": "180000",
          "TargetGroupName": "job"
        }
      ],
      "Engine": "",
      "Message": "",
      "AutoStopInterval": "",
      "SpecName": "",
      "TargetResourceGroupName": "",
      "MinGpuQuantity": 0,
      "MaxGpuQuantity": 0,
      "RayConfig": {
        "EnableUserEni": false,
        "HeadSpecType": "",
        "HeadSpec": "",
        "HeadAllocateUnit": "",
        "HeadDiskCapacity": "",
        "Category": "",
        "WorkerGroups": [
          {
            "GroupName": "g01",
            "AllocateUnit": "1",
            "MaxWorkerQuantity": 1,
            "MinWorkerQuantity": 1,
            "WorkerDiskCapacity": "100G",
            "WorkerSpecName": "large",
            "WorkerSpecType": "CPU"
          }
        ],
        "RayClusterAddress": "http://ray-cluster-address.example.com",
        "RayDashboardAddress": "http://ray-dashboard-address.example.com",
        "RayGrafanaAddress": "http://ray-grafana-address.example.com",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01"
          }
        ]
      },
      "GpuElasticPlan": {
        "Enabled": false,
        "Rules": [
          {
            "StartCronExpression": "",
            "EndCronExpression": ""
          }
        ]
      },
      "ScalePolicy": "",
      "Classification": "",
      "EngineParams": {
        "key": ""
      }
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidPoolName.Malformed	The specified parameter PoolName is not valid.
400	InvalidPoolUser.Malformed	The specified parameter PoolUser is not valid.
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPoolType.Malformed	The specified parameter PoolType is not valid.
400	InvalidMinComputeResource.Malformed	The specified parameter MinComputeResource is not valid.
400	InvalidMaxComputeResource.Malformed	The specified parameter MaxComputeResource is not valid.
408	AcsServerTimeOut	The request has failed due to Adb Cloud Service time out.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.