DescribeDBClusters - AnalyticDB

Daftar kluster Edisi Data Lakehouse.

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

get

DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Catatan Anda dapat memanggil operasi DescribeRegions untuk melihat daftar ID wilayah yang tersedia.	cn-hangzhou
DBClusterIds	string	No	ID kluster. Catatan Anda dapat menentukan ID kluster apa pun di wilayah yang ditentukan.	am-bp1r053byu48p****
DBClusterDescription	string	No	Deskripsi kluster. Tidak boleh diawali dengan `http://` atau `https://`. Panjangnya harus antara 2 hingga 256 karakter.	test
DBClusterStatus	string	No	Status kluster. Nilai yang valid: Preparing: Sedang dipersiapkan. Creating: Sedang dibuat. Restoring: Memulihkan dari backup. Running: Berjalan. Deleting: Sedang dihapus. ClassChanging: Meningkatkan atau menurunkan spesifikasi. NetAddressCreating: Membuat titik akhir jaringan. NetAddressDeleting: Menghapus titik akhir jaringan.	Running
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 30 (default) 50 100	30
PageNumber	integer	No	Nomor halaman. Nilai yang valid adalah bilangan bulat lebih besar dari 0 dan kurang dari atau sama dengan nilai maksimum tipe data integer. Nilai default: 1.	1
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-4690g37929XXXX
Tag	array<object>	No	Daftar tag.
	object	No	Detail tentang item dalam daftar.
Key	string	No	Kunci tag. Anda dapat memfilter kluster berdasarkan kunci tag. Anda dapat menentukan hingga 20 pasangan kunci-nilai. Angka n dalam `Tag.N.Key` dan `Tag.N.Value` harus unik dan merupakan bilangan bulat berurutan yang dimulai dari 1. Catatan Panjang kunci tag maksimal 64 karakter. Tidak boleh diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`.	tag1
Value	string	No	Nilai tag. Anda dapat memfilter kluster berdasarkan nilai tag. Anda dapat menentukan hingga 20 pasangan kunci-nilai. Angka n dalam `Tag.N.Key` dan `Tag.N.Value` harus unik dan merupakan bilangan bulat berurutan yang dimulai dari 1. Catatan Panjang nilai tag maksimal 64 karakter. Tidak boleh diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`.	test1
DBVersion	string	No	Versi database. Nilai yang valid: 3.0.	3.0
DBClusterVersion	string	No	Versi kluster 3.0: Edisi Data Warehouse. 5.0 (default): Termasuk Edisi Data Lakehouse, Edisi Perusahaan, dan Edisi Dasar. All: Semua versi, termasuk Edisi Data Warehouse, Edisi Data Lakehouse, Edisi Perusahaan, dan Edisi Dasar.	3.0

Elemen respons

Element	Type	Description	Example
	object	Detail tentang daftar yang dikembalikan.
TotalCount	integer	Jumlah total entri.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	30
RequestId	string	ID permintaan.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	Nomor halaman.	1
Items	object
DBCluster	array<object>	Daftar kluster.
	array<object>	Detail tentang daftar kluster.
DtsJobId	string	ID task sinkronisasi DTS. Parameter ini hanya dikembalikan untuk instansi analitik MySQL.	dtsb1578j90XXXX
DBNodeCount	integer	Jumlah grup node.	1
Expired	string	Menunjukkan apakah kluster telah kedaluwarsa. Nilai yang valid: true: Kedaluwarsa. false: Belum kedaluwarsa.	false
CreateTime	string	Waktu pembuatan kluster, dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Contoh: 2021-04-01T09:50:18Z.	2021-04-01T09:50:18Z
PayType	string	Metode penagihan. Nilai yang valid: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Postpaid
DiskType	string	Tipe disk. Nilai yang valid: local_ssd: SSD lokal. cloud: Disk dasar. cloud_ssd: SSD Standar. cloud_efficiency: Ultra disk. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Catatan Untuk informasi selengkapnya mengenai ESSD, lihat Spesifikasi ESSD.	cloud_essd
Tags	object
Tag	array<object>	Daftar tag.
	object	Detail tentang daftar tag.
Key	string	Kunci tag. Catatan Anda dapat memanggil operasi TagResources untuk menambahkan tag ke kluster.	tag1
Value	string	Nilai tag.	test1
Mode	string	Mode kluster. Nilai yang valid: flexible: Mode fleksibel. reserver: Mode reservasi. Catatan Untuk informasi selengkapnya, lihat Edisi produk.	flexible
Port	string	Nomor port. Nilai default: 3306.	3306
LockMode	string	Mode kunci kluster. Nilai yang valid: Unlock: Tidak terkunci. ManualLock: Dikunci secara manual. LockByExpiration: Dikunci karena kedaluwarsa. LockByRestoration: Dikunci sebelum rollback. LockByDiskQuota: Dikunci karena penggunaan penyimpanan mencapai 90% dari kuota.	Unlock
StorageResource	string	Spesifikasi sumber daya penyimpanan yang digunakan dalam mode fleksibel untuk operasi baca dan tulis. Meningkatkan sumber daya ini akan meningkatkan kinerja baca dan tulis kluster.	8Core32GB
ExecutorCount	string	Jumlah node komputasi yang digunakan oleh kluster dalam mode fleksibel.	1
DBClusterId	string	ID kluster.	am-bp163885f8q21****
ConnectionString	string	Titik akhir publik kluster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	ID instans ApsaraDB RDS sumber. Parameter ini hanya dikembalikan untuk instansi analitik MySQL.	rm-bp11q28kvl688****
DBClusterType	string	Tipe kluster. Nilai yang valid: Common: Kluster standar. RDS_ANALYSIS: Instansi analitik MySQL.	Common
CommodityCode	string	Kode komoditas. Nilai tetap: ads.	ads
ExpireTime	string	Waktu kedaluwarsa kluster, dalam UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Contoh: 2999-09-08T16:00:00Z. Catatan Jika kluster menggunakan metode penagihan subscription, parameter ini mengembalikan waktu kedaluwarsa aktual. Jika kluster menggunakan metode penagihan pay-as-you-go, parameter ini mengembalikan nilai tetap 2999-09-08T16:00:00Z.	2999-09-08T16:00:00Z
DBNodeStorage	integer	Kapasitas penyimpanan kluster, dalam GB.	300
DBNodeClass	string	Spesifikasi node.	E8
LockReason	string	Alasan mengapa kluster dikunci. Catatan Parameter ini hanya dikembalikan jika kluster dikunci. Nilai tetap: instance_expire.	instance_expired
VPCId	string	ID virtual private cloud (VPC).	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	ID wilayah tempat kluster berada.	cn-hangzhou
ComputeResource	string	Spesifikasi sumber daya komputasi yang digunakan dalam mode fleksibel untuk pemrosesan data. Meningkatkan sumber daya komputasi mempercepat kueri. Anda dapat menyesuaikan sumber daya ini sesuai kebutuhan.	8Core32GB
ElasticIOResource	integer	Unit IO Elastis (EIU). Untuk informasi selengkapnya, lihat Ikhtisar EIU. Catatan Parameter ini hanya dikembalikan untuk kluster dalam mode fleksibel.	0
VSwitchId	string	ID vSwitch.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	Versi database. Hanya versi 3.0 yang didukung.	3.0
VPCCloudInstanceId	string	ID instans VPC.	am-bp163885f8q21****-controller
DBClusterStatus	string	Status kluster. Untuk informasi selengkapnya, lihat Tabel status.	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
Category	string	Edisi produk. Nilai yang valid: BASIC: Edisi Dasar dalam mode reservasi. CLUSTER: Edisi Kluster dalam mode reservasi. MIXED_STORAGE: Edisi Kluster dalam mode fleksibel (baru). Catatan Untuk informasi selengkapnya, lihat Edisi produk.	MIXED_STORAGE
Engine	string	Engine kluster. Nilai tetap: AnalyticDB.	AnalyticDB
InnerIp	string	Alamat IP publik.	10.1.xx.xx
InnerPort	string	Nomor port.	3306
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 %.	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 %.	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
ProductVersion	string	Versi produk. Nilai yang valid: BasicVersion: Edisi Dasar. EnterpriseVersion: Edisi Perusahaan.	EnterpriseVersion

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "8Core32GB",
        "ExecutorCount": "1",
        "DBClusterId": "am-bp163885f8q21****",
        "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "8Core32GB",
        "ElasticIOResource": 0,
        "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "InnerIp": "10.1.xx.xx",
        "InnerPort": "3306",
        "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"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

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.