Gunakan DescribeDBClusters untuk mengkueri detail kluster - PolarDB - Alibaba Cloud - PolarDB

Mengkueri detail kluster PolarDB Basis Data Relasional Cloud-Native atau kluster yang diotorisasi oleh Otorisasi RAM.

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

polardb:DescribeDBClusters

list

*DBCluster.

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Catatan Anda dapat memanggil operasi DescribeRegions untuk mengkueri wilayah yang tersedia.	cn-hangzhou
DBClusterIds	string	No	ID kluster. Pisahkan beberapa ID kluster dengan koma (,).	pc-****************
DBClusterDescription	string	No	Deskripsi kluster. Pencocokan kabur didukung.	pc-****************
ConnectionString	string	No	Titik akhir database.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	No	Status kluster. Untuk nilai valid, lihat Tabel status kluster.	Running
DBType	string	No	Jenis database. Nilai valid: MySQL PostgreSQL Oracle	MySQL
DescribeType	string	No	Mode kueri untuk daftar. Atur nilai ke Simple untuk menggunakan mode sederhana, yang hanya mengembalikan metadata dasar kluster. Catatan Jika Anda tidak menentukan parameter ini, mode detail digunakan secara default, yang mengembalikan informasi detail tentang kluster.	Simple
DBVersion	string	No	Versi mesin database.	5.6
RecentCreationInterval	integer	No	Memfilter kluster yang dibuat dalam N hari terakhir. Nilai valid: 0 hingga 15.	7
RecentExpirationInterval	integer	No	Memfilter kluster yang kedaluwarsa dalam N hari berikutnya. Nilai valid: 0 hingga 15.	6
Expired	boolean	No	Apakah kluster telah kedaluwarsa. Nilai valid: true false	true
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 30, 50, dan 100. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai harus berupa bilangan bulat positif yang tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.	10
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-**********
Tag	array<object>	No	Tag.
	object	No
Key	string	No	Kunci tag. Anda dapat menggunakan tag untuk memfilter daftar kluster. Anda dapat menentukan hingga 20 pasangan tag. Angka n untuk setiap pasangan tag harus unik dan harus berupa bilangan bulat berurutan yang dimulai dari 1. Parameter Tag.n.Key dipasangkan dengan parameter Tag.n.Value. Catatan Panjang kunci tag dapat mencapai 64 karakter dan tidak boleh diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`.	MySQL
Value	string	No	Nilai tag yang sesuai dengan kunci tag. Catatan Panjang nilai tag dapat mencapai 64 karakter dan tidak boleh diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`.	5.6
PayType	string	No	Metode penagihan. Nilai valid: Postpaid: bayar sesuai pemakaian. Prepaid: langganan.	Postpaid
DBNodeIds	string	No	ID node. Anda dapat menentukan beberapa ID node, dipisahkan dengan koma (,).	pi-***************

Elemen respons

Element	Type	Description	Example
	object
TotalRecordCount	integer	Jumlah total rekaman.	16
PageRecordCount	integer	Jumlah kluster pada halaman saat ini.	5
RequestId	string	ID permintaan.	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	Nomor halaman.	12
Items	object
DBCluster	array<object>	Daftar kluster.
	array<object>
VpcId	string	ID VPC.	vpc-****************
VswitchId	string	ID VSwitch.	vsw-***************
ExpireTime	string	Waktu kedaluwarsa kluster. Catatan Parameter ini hanya dikembalikan untuk kluster Prepaid (berlangganan). Untuk kluster Postpaid (bayar sesuai pemakaian), string kosong yang dikembalikan.	2020-11-14T16:00:00Z
Expired	string	Menunjukkan apakah kluster telah kedaluwarsa. Nilai yang valid: true false Catatan Parameter ini hanya dikembalikan untuk kluster Prepaid (berlangganan).	false
DBNodeNumber	integer	Jumlah node.	2
CreateTime	string	Waktu kluster dibuat.	2020-08-14T05:58:42Z
PayType	string	Metode penagihan. Nilai yang valid: Postpaid: bayar sesuai pemakaian. Prepaid: berlangganan.	Prepaid
StoragePayType	string	Metode penagihan untuk penyimpanan. Nilai yang valid: Postpaid: bayar sesuai pemakaian (bayar per kapasitas). Prepaid: berlangganan (bayar per ruang).	Prepaid
ServerlessType	string	Jenis serverless. Nilai AgileServerless menunjukkan kluster serverless. String kosong menunjukkan kluster reguler.	AgileServerless
StrictConsistency	string	Menunjukkan apakah konsistensi kuat multi-zona diaktifkan untuk kluster. Nilai yang valid: ON: Konsistensi kuat multi-zona diaktifkan. Ini berlaku untuk kluster Standard Edition yang di-deploy di tiga zona. OFF: Konsistensi kuat multi-zona dinonaktifkan.	ON
DBNodeClass	string	Spesifikasi node.	polar.mysql.x4.large
Tags	object	Tag kluster.
Tag	array<object>	Daftar tag.
	object	1
Key	string	Kunci tag.	MySQL
Value	string	Nilai tag.	5.6
DBType	string	Jenis database.	MySQL
LockMode	string	Mode penguncian kluster. Nilai yang valid: Unlock: Kluster tidak terkunci. ManualLock: Kluster dikunci secara manual. LockByExpiration: Kluster dikunci secara otomatis setelah kedaluwarsa.	Unlock
DBNodes	object	Detail node dalam kluster.
DBNode	array<object>	Daftar node.
	object
DBNodeClass	string	Spesifikasi node.	polar.mysql.x4.large
ZoneId	string	ID zona.	cn-hangzhou-i
DBNodeRole	string	Peran node. Nilai yang valid: Writer: node utama. Reader: node hanya-baca. ColumnReader: node hanya-baca penyimpanan kolom. AI: node AI.	Reader
DBNodeId	string	ID node.	pi-****************
RegionId	string	ID region.	cn-hangzhou
Serverless	string	Menunjukkan apakah fitur serverless diaktifkan untuk node. Nilai ON menunjukkan bahwa fitur diaktifkan. String kosong menunjukkan bahwa fitur dinonaktifkan.	ON
ImciSwitch	string	Menunjukkan apakah fitur indeks columnstore diaktifkan. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	OFF
HotReplicaMode	string	Menunjukkan apakah fitur hot standby diaktifkan. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	OFF
RegionId	string	ID region.	cn-hangzhou
DeletionLock	integer	Status penguncian penghapusan kluster. Nilai yang valid: 0: tidak terkunci. 1: terkunci. Catatan Anda tidak dapat menghapus kluster yang terkunci.	0
DBVersion	string	Versi database.	5.6
DBClusterId	string	ID kluster.	pc-****************
DBClusterStatus	string	Status kluster.	Running
ResourceGroupId	string	ID grup resource.	rg-************
SearchStorageUsed	integer	Penggunaan penyimpanan node pencarian.	89227945573
StorageSpace	integer	Ruang penyimpanan kluster berlangganan. Unit: byte.	50
DBClusterNetworkType	string	Jenis jaringan kluster.	VPC
DBClusterDescription	string	Deskripsi kluster.	GDN-1
ZoneId	string	ID zona.	cn-hangzhou-i
Engine	string	Mesin database.	POLARDB
Category	string	Edisi kluster. Nilai yang valid: Normal: edisi kluster Basic: edisi node tunggal Archive: edisi X-Engine NormalMultimaster: edisi kluster multi-master (Database/Tabel)	Normal
AiType	string	Jenis node AI. Nilai yang valid: SearchNode: Kluster berisi node pencarian. DLNode: Kluster berisi node AI. Valid values: SearchNode\|DLNode : Both DLNode : DLNode SearchNode : SearchNode	SearchNode
CpuCores	string	Jumlah inti CPU.	1
MemorySize	string	Ukuran memori node. Unit: MB.	2048
StorageType	string	Jenis penyimpanan kluster Enterprise Edition. Nilai yang valid: HighPerformance: PL5 Standard: PL4 Jenis penyimpanan kluster Standard Edition. Nilai yang valid: essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	Menunjukkan apakah hot standby penyimpanan diaktifkan. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	OFF
SubCategory	string	Jenis spesifikasi node komputasi. Nilai yang valid: Exclusive: spesifikasi khusus General: spesifikasi tujuan umum	Exclusive
StorageUsed	integer	Ruang penyimpanan yang digunakan. Unit: byte.	3009413120
RemoteMemorySize	string	Ukuran memori jarak jauh. Unit: MB.	3612
ConnectionResourceQuota	integer
ConnectionResourceUsed	integer

Contoh

Respons sukses

JSONformat

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": {
    "DBCluster": [
      {
        "VpcId": "vpc-****************",
        "VswitchId": "vsw-***************",
        "ExpireTime": "2020-11-14T16:00:00Z",
        "Expired": "false",
        "DBNodeNumber": 2,
        "CreateTime": "2020-08-14T05:58:42Z",
        "PayType": "Prepaid",
        "StoragePayType": "Prepaid",
        "ServerlessType": "AgileServerless",
        "StrictConsistency": "ON",
        "DBNodeClass": "polar.mysql.x4.large",
        "Tags": {
          "Tag": [
            {
              "Key": "MySQL",
              "Value": "5.6"
            }
          ]
        },
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "DBNodes": {
          "DBNode": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "ZoneId": "cn-hangzhou-i",
              "DBNodeRole": "Reader",
              "DBNodeId": "pi-****************",
              "RegionId": "cn-hangzhou",
              "Serverless": "ON",
              "ImciSwitch": "OFF",
              "HotReplicaMode": "OFF"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "5.6",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-************",
        "SearchStorageUsed": 89227945573,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode",
        "CpuCores": "1",
        "MemorySize": "2048",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF",
        "SubCategory": "Exclusive",
        "StorageUsed": 3009413120,
        "RemoteMemorySize": "3612",
        "ConnectionResourceQuota": 0,
        "ConnectionResourceUsed": 0
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	Parameter RegionId yang ditentukan tidak valid.
400	NumberExceed.Tags	The Tags parameter's number is exceed.	Jumlah parameter tags telah terlampaui.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	Parameter PageSize yang ditentukan tidak valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	Parameter PageNumber yang ditentukan tidak valid.
400	InvalidRecentCreationInterval.Malformed	The specified parameter RecentCreationInterval is not valid.	Parameter RecentCreationInterval yang ditentukan tidak valid.
400	InvalidRecentExpirationInterval.Malformed	The specified parameter RecentExpirationInterval is not valid.	Parameter RecentExpirationInterval yang ditentukan tidak valid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Pemrosesan permintaan gagal karena error, pengecualian, atau kegagalan yang tidak diketahui.
404	DBTypeOrDBVersion.Malformed	The specified DBType does not match DBVersion.	DBType yang ditentukan tidak cocok dengan DBVersion.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	Permintaan gagal karena kegagalan server sementara.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.