DescribeDBClusters - AnalyticDB

Menampilkan daftar kluster Edisi Data Lakehouse di wilayah target.

Deskripsi operasi

Untuk endpoint layanan saat ini, lihat endpoint.

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:DescribeDBClusters

list

*DBClusterLakeVersion

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID Wilayah. Catatan Panggil operasi DescribeRegions untuk melihat ID wilayah.	cn-hangzhou
DBClusterIds	string	No	ID kluster Edisi Data Lakehouse. Jika Anda tidak menentukan parameter ini, sistem secara default mengembalikan informasi tentang semua kluster di wilayah tersebut.	amv-bp1r053byu48p****
DBClusterDescription	string	No	Deskripsi kluster. Tidak boleh diawali dengan `http://` atau `https://`. Panjang: 2 hingga 256 karakter.	test
DBClusterStatus	string	No	Status kluster. Nilai yang valid: Preparing: Sedang dipersiapkan. Creating: Sedang dibuat. Running: Berjalan. Deleting: Sedang dihapus. Restoring: Memulihkan backup. ClassChanging: Melakukan upgrade atau downgrade. NetAddressCreating: Membuat alamat jaringan. NetAddressDeleting: Menghapus alamat jaringan. NetAddressModifying: Memodifikasi alamat jaringan.	Running
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 30 (default) 50 100	30
PageNumber	integer	No	Nomor halaman. Nilai yang valid: bilangan bulat positif lebih besar dari 0 dan kurang dari atau sama dengan nilai maksimum tipe data integer. Nilai default: 1.	1
ResourceGroupId	string	No	Jika Anda tidak menentukan parameter ini, sistem secara default mengembalikan informasi tentang semua kelompok sumber daya di kluster.	rg-4690g37929****
Tag	array<object>	No	Tag kluster.
	object	No	Informasi tag kluster.
Key	string	No	Kunci tag.	tag1
Value	string	No	Nilai tag.	test1
ProductVersion	string	No	Versi produk. Nilai yang valid: EnterpriseVersion: Edisi Perusahaan. BasicVersion: Edisi Dasar. Catatan Ini adalah parameter opsional. Jika Anda tidak menentukannya, sistem secara default mengembalikan informasi tentang semua kluster.	BasicVersion
DBClusterVersion	string	No	Versi kluster. Nilai yang valid: 3.0: Edisi Data Warehouse. 5.0 (default): Edisi Data Lakehouse, Edisi Perusahaan, dan Edisi Dasar. All: Semua versi, termasuk Edisi Data Warehouse, Edisi Data Lakehouse, Edisi Perusahaan, dan Edisi Dasar.	5.0

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	Total jumlah entri.	1
PageSize	integer	Jumlah entri per halaman.	30
RequestId	string	ID permintaan.	A5EDBA27-AF3E-5966-9503-FD1557E19167
PageNumber	integer	Nomor halaman.	1
Items	object
DBCluster	array<object>	Informasi daftar detail.
	array<object>	Daftar kluster.
Expired	string	Menunjukkan apakah kluster langganan telah kedaluwarsa. Nilai yang valid: true: Kedaluwarsa. false: Belum kedaluwarsa. Catatan Jika kluster kedaluwarsa, kluster tersebut mungkin dikunci atau dilepas setelah periode tenggang. Kami menyarankan agar Anda memperpanjang langganan Anda. Untuk informasi selengkapnya, lihat Kebijakan perpanjangan. Parameter ini tidak dikembalikan untuk kluster pay-as-you-go.	false
CreateTime	string	Waktu pembuatan kluster dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-04-01T09:50:18Z
PayType	string	Jenis pembayaran. Nilai yang valid: Postpaid: Pay-as-you-go. Prepaid: Langganan.	Prepaid
Mode	string	Mode kluster. Nilai default: flexible, yang menunjukkan kluster mode elastis.	flexible
Port	string	Nomor port kluster.	3306
LockMode	string	Status kunci kluster. Nilai yang valid: Unlock: Tidak terkunci. ManualLock: Dikunci secara manual. LockByExpiration: Dikunci karena kedaluwarsa.	Unlock
StorageResource	string	Spesifikasi sumber daya penyimpanan yang dipesan. Satu ACU setara dengan sekitar satu vCPU dan 4 GB memori. Sumber daya penyimpanan digunakan untuk operasi baca dan tulis data. Meningkatkan sumber daya ini meningkatkan performa baca dan tulis kluster.	24ACU
DBClusterId	string	ID kluster Edisi Data Lakehouse.	amv-bp163885f8q21****
ConnectionString	string	Endpoint publik kluster.	amv-bp163885f8q21****.ads.aliyuncs.com
DBClusterType	string	Jenis kluster. Nilai default: Common, yang menunjukkan kluster standar.	Common
CommodityCode	string	Jenis pembayaran komoditas. Nilai yang valid: ads: Komoditas pay-as-you-go. ads_pre: Komoditas langganan.	ads_pre
ExpireTime	string	Waktu kedaluwarsa kluster dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Catatan Parameter ini mengembalikan waktu kedaluwarsa aktual jika kluster menggunakan metode penagihan langganan. Parameter ini mengembalikan string kosong jika kluster menggunakan metode penagihan pay-as-you-go.	2022-07-01T09:50:18Z
LockReason	string	Alasan mengapa kluster dikunci. Catatan Parameter ini hanya dikembalikan ketika kluster dikunci. Nilainya selalu instance_expire.	instance_expired
VPCId	string	ID Virtual Private Cloud (VPC).	vpc-bp13h7uzhulpuxvnp****
RegionId	string	ID wilayah tempat kluster berada.	cn-hangzhou
ComputeResource	string	Spesifikasi sumber daya komputasi yang dipesan. Satu ACU setara dengan sekitar satu vCPU dan 4 GB memori. Sumber daya komputasi digunakan untuk pemrosesan data. Meningkatkan sumber daya komputasi mempercepat query. Anda dapat menaikkan atau menurunkan sumber daya ini sesuai kebutuhan performa kluster Anda.	16ACU
VSwitchId	string	ID vSwitch.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	Versi database. Hanya versi 5.0 yang didukung.	5.0
DBClusterStatus	string	Status kluster. Nilai yang valid: Preparing: Sedang dipersiapkan. Creating: Sedang dibuat. Running: Berjalan. Deleting: Sedang dihapus. Restoring: Memulihkan backup. ClassChanging: Melakukan upgrade atau downgrade. NetAddressCreating: Membuat alamat jaringan. NetAddressDeleting: Menghapus alamat jaringan. NetAddressModifying: Memodifikasi alamat jaringan.	Running
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	Jenis jaringan kluster. Hanya VPC yang didukung.	VPC
DBClusterDescription	string	Deskripsi kluster.	adb_test
ZoneId	string	ID zona tempat kluster berada.	cn-hangzhou-h
Engine	string	Mesin kluster. Nilai tetap: AnalyticDB.	AnalyticDB
ReservedACU	string	Sisa sumber daya komputasi yang dipesan yang tersedia untuk alokasi. Satu ACU setara dengan sekitar satu vCPU dan 4 GB memori.	32ACU
Tags	object
Tag	array<object>	Daftar tag.
	object	Daftar tag.
Key	string	Kunci tag. Catatan Panggil operasi TagResources untuk membuat tag untuk kluster target.	tag1
Value	string	Nilai tag.	test1
Category	string	Seri produk. Parameter ini hanya berlaku untuk instans Edisi Data Warehouse. Nilai yang valid: BASIC: Edisi Dasar mode reservasi. CLUSTER: Edisi Kluster mode reservasi. MIXED_STORAGE: Edisi Kluster mode elastis (baru). Catatan Untuk informasi selengkapnya tentang seri produk, lihat seri produk.	MIXED_STORAGE
InnerPort	string	Port jaringan internal kluster.	3306
VPCCloudInstanceId	string	Endpoint internal.	am-bp163885f8q21****-controller
InnerIp	string	Alamat IP internal kluster.	10.1.xx.xx
DtsJobId	string	ID tugas sinkronisasi DTS. Parameter ini hanya dikembalikan untuk instansi analitik MySQL.	dtsb1578j90XXXX
ElasticIOResource	integer	Elastic IO Unit (EIU). Untuk informasi selengkapnya, lihat Detail EIU. Catatan Parameter ini hanya dikembalikan untuk kluster mode elastis.	2
RdsInstanceId	string	ID instans RDS sumber untuk sinkronisasi. Parameter ini hanya dikembalikan untuk instansi analitik MySQL.	rm-bp11q28kvl688****
ExecutorCount	string	Jumlah node komputasi yang digunakan oleh kluster dalam mode elastis.	1
DBNodeClass	string	Spesifikasi node. Parameter ini hanya berlaku untuk instans Edisi Data Warehouse.	E8
DiskType	string	Jenis disk. Nilai yang valid: local_ssd: SSD lokal. cloud: Disk dasar. cloud_ssd: SSD standar. cloud_efficiency: Ultra disk. cloud_essd: Disk ESSD (level PL1). cloud_essd2: Disk ESSD (level PL2). cloud_essd3: Disk ESSD (level PL3). Catatan Untuk informasi selengkapnya tentang disk ESSD, lihat Spesifikasi disk ESSD.	cloud_essd
DBNodeStorage	integer	Kapasitas penyimpanan kluster, dalam GB.	300
DBNodeCount	integer	Jumlah grup node.	2
TaskInfo	object	Informasi progres tugas.
Name	string	Nama tugas.	analyticDBFlexibleScaleOut
Status	string	Status tugas. Nilai yang valid: NOT_RUN: Menunggu untuk dijalankan. RUNNING: Sedang berjalan. SUCCEED: Selesai.	RUNNING
Progress	string	Progres tugas, dalam persen (%).	10%
StepList	object
StepList	array<object>	Langkah-langkah tugas.
	object	Langkah tugas.
StepName	string	Nama langkah.	ApplyResource
StepDesc	string	Deskripsi langkah.	Apply resource
StepStatus	string	Status langkah. Nilai yang valid: NOT_RUN: Menunggu untuk dijalankan. RUNNING: Sedang berjalan. SUCCEED: Selesai.	SUCCEED
StepProgress	string	Progres langkah, dalam persen (%).	50%
StartTime	string	Waktu mulai langkah. Format: YYYY-MM-DDTHH:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	Waktu selesai langkah. Format: YYYY-MM-DDTHH:mm:ssZ.	2024-03-10T10:28:34Z
ProductForm	string	Bentuk produk. Nilai yang valid: LegacyForm: Bentuk tradisional. IntegrationForm: Bentuk terintegrasi.	IntegrationForm
ProductVersion	string	Versi produk. Nilai yang valid: BasicVersion: Edisi Dasar. EnterpriseVersion: Edisi Perusahaan.	EnterpriseVersion
ReservedNodeSize	string	Spesifikasi setiap node sumber daya yang dipesan.	8ACU
ReservedNodeCount	integer	Jumlah node sumber daya yang dipesan.	1
AINodeSpec	string
AINodeNumber	integer

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "Expired": "false",
        "CreateTime": "2022-04-01T09:50:18Z",
        "PayType": "Prepaid",
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-bp163885f8q21****",
        "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-07-01T09:50:18Z",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "16ACU",
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "32ACU",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Category": "MIXED_STORAGE",
        "InnerPort": "3306",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "InnerIp": "10.1.xx.xx",
        "DtsJobId": "dtsb1578j90XXXX",
        "ElasticIOResource": 2,
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "ExecutorCount": "1",
        "DBNodeClass": "E8",
        "DiskType": "cloud_essd",
        "DBNodeStorage": 300,
        "DBNodeCount": 2,
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10%",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50%",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductForm": "IntegrationForm",
        "ProductVersion": "EnterpriseVersion",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 1,
        "AINodeSpec": "",
        "AINodeNumber": 0
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.