Gunakan DescribeDBClusters untuk mengkueri detail kluster - PolarDB

Mengambil detail kluster PolarDB, termasuk kluster yang telah Anda otorisasi untuk diakses melalui Resource Access Management (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 melihat wilayah yang tersedia.	cn-hangzhou
DBClusterIds	string	No	ID kluster. Pisahkan beberapa ID kluster dengan koma (,).	pc-****************
DBClusterDescription	string	No	Deskripsi kluster. Pencarian fuzzy didukung.	pc-****************
ConnectionString	string	No	Titik akhir database.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	No	Status kluster. Untuk informasi selengkapnya, lihat tabel status kluster.	Running
DBType	string	No	Tipe database. Nilai yang valid: MySQL PostgreSQL Oracle	MySQL
DescribeType	string	No	Mode kueri. Tetapkan nilai ke `Simple` untuk hanya menanyakan metadata dasar kluster. Catatan Jika Anda tidak menentukan parameter ini, informasi detail tentang kluster akan dikembalikan.	Simple
DBVersion	string	No	Versi database.	5.6
RecentCreationInterval	integer	No	Memfilter kluster yang dibuat dalam N hari terakhir. Nilai N harus berupa bilangan bulat dari 0 hingga 15.	7
RecentExpirationInterval	integer	No	Memfilter kluster yang akan kedaluwarsa dalam N hari. Nilai N harus berupa bilangan bulat dari 0 hingga 15.	6
Expired	boolean	No	Menentukan apakah kluster telah kedaluwarsa. Nilai yang valid: true false	true
PageSize	integer	No	Jumlah catatan yang dikembalikan pada setiap halaman. Nilai yang valid: 30, 50, dan 100. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data INTEGER. Nilai default: 1.	10
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-**********
Tag	array<object>	No	Daftar tag.
	object	No
Key	string	No	Kunci tag. Anda dapat memfilter kluster berdasarkan tag. Anda dapat menentukan hingga 20 pasangan tag. Angka `n` dalam `Tag.n.Key` harus berupa bilangan bulat unik dan berurutan yang dimulai dari 1. Nilai `Tag.n.Key` berkorespondensi dengan nilai `Tag.n.Value`. Catatan Panjang kunci tag maksimal 64 karakter dan tidak boleh diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`.	MySQL
Value	string	No	Nilai kunci tag. Catatan Panjang nilai tag maksimal 64 karakter dan tidak boleh diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`.	5.6
PayType	string	No	Metode penagihan. Nilai yang valid: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
DBNodeIds	string	No	ID node. Anda dapat menentukan beberapa ID node. Pisahkan beberapa ID dengan koma (,).	pi-***************

Elemen respons

Element	Type	Description	Example
	object
TotalRecordCount	integer	Jumlah total catatan.	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 virtual private cloud (VPC).	vpc-****************
VswitchId	string	ID virtual switch.	vsw-***************
ExpireTime	string	Waktu kedaluwarsa kluster. Catatan Parameter ini hanya dikembalikan untuk kluster Prepaid (subscription). Untuk kluster Postpaid (pay-as-you-go), string kosong 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 (subscription).	false
DBNodeNumber	integer	Jumlah node.	2
CreateTime	string	Waktu pembuatan kluster.	2020-08-14T05:58:42Z
PayType	string	Metode penagihan. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
StoragePayType	string	Metode penagihan penyimpanan. Nilai yang valid: Postpaid: pay-as-you-go (pay-by-capacity). Prepaid: subscription (pay-by-space).	Prepaid
ServerlessType	string	Tipe Serverless. Jika AgileServerless dikembalikan, kluster tersebut merupakan kluster Serverless. Jika string kosong dikembalikan, kluster tersebut merupakan kluster reguler.	AgileServerless
StrictConsistency	string	Menunjukkan apakah konsistensi data kuat diaktifkan untuk kluster multi-zona. Nilai yang valid: ON: Konsistensi data kuat diaktifkan. Ini berlaku untuk kluster Edisi Standar yang ditempatkan di tiga zona. OFF: Konsistensi data kuat tidak diaktifkan.	ON
DBNodeClass	string	Spesifikasi node.	polar.mysql.x4.large
Tags	object
Tag	array<object>	Daftar tag.
	object
Key	string	Kunci tag.	MySQL
Value	string	Nilai tag.	5.6
DBType	string	Tipe database.	MySQL
LockMode	string	Status penguncian kluster. Nilai yang valid: Unlock: Kluster tidak terkunci. ManualLock: Kluster dikunci secara manual. LockByExpiration: Kluster dikunci otomatis setelah kedaluwarsa.	Unlock
DBNodes	object
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 primary. Reader: node read-only. ColumnReader: node read-only penyimpanan kolom. AI: node AI.	Reader
DBNodeId	string	ID node.	pi-****************
RegionId	string	ID wilayah.	cn-hangzhou
Serverless	string	Menunjukkan apakah fitur Serverless diaktifkan untuk node tersebut. Jika ON dikembalikan, fitur Serverless diaktifkan. Jika string kosong dikembalikan, fitur Serverless tidak diaktifkan.	ON
ImciSwitch	string	Menunjukkan apakah fitur indeks penyimpanan kolom 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 wilayah.	cn-hangzhou
DeletionLock	integer	Status perlindungan kluster terhadap penghapusan. Nilai yang valid: 0: Kluster tidak terkunci. 1: Kluster 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 kelompok sumber daya.	rg-************
SearchStorageUsed	integer
StorageSpace	integer	Storage space kluster langganan. Satuan: byte.	50
DBClusterNetworkType	string	Jenis jaringan kluster.	VPC
DBClusterDescription	string	Deskripsi kluster.	GDN-1
ZoneId	string	ID zona.	cn-hangzhou-i
Engine	string	Engine kluster.	POLARDB
Category	string	Edisi kluster. Edisi yang didukung: Normal: Edisi Kluster Basic: Single Node Archive: X-Engine NormalMultimaster: Kluster Multi-master (Database/Tabel)	Normal
AiType	string	Status node AI. Nilai yang valid: SearchNode: search node DLNode: node AI Valid values: SearchNode\|DLNode : Keduanya DLNode : DLNode SearchNode : SearchNode	SearchNode
CpuCores	string	Jumlah core CPU.	1
MemorySize	string	Ukuran memori node. Satuan: MB.	2048
RemoteMemorySize	string	Ukuran memori remote. Satuan: MB.	3612
StorageType	string	Kelas penyimpanan kluster Edisi Perusahaan. Nilai yang valid: HighPerformance: sesuai dengan PSL5 Standard: sesuai dengan PSL4 Kelas penyimpanan kluster Edisi Standar. Nilai yang valid: essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	Klaster penyimpanan siaga panas. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	OFF
SubCategory	string	Jenis spesifikasi node komputasi. Nilai yang valid: Exclusive: Dedicated General: tujuan umum	Exclusive
StorageUsed	integer	Ruang penyimpanan yang digunakan oleh kluster. Satuan: byte.	3009413120

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": 0,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode",
        "CpuCores": "1",
        "MemorySize": "2048",
        "RemoteMemorySize": "3612",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF",
        "SubCategory": "Exclusive",
        "StorageUsed": 3009413120
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.
400	NumberExceed.Tags	The Tags parameter's number is exceed.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
400	InvalidRecentCreationInterval.Malformed	The specified parameter RecentCreationInterval is not valid.
400	InvalidRecentExpirationInterval.Malformed	The specified parameter RecentExpirationInterval is not valid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	DBTypeOrDBVersion.Malformed	The specified DBType does not match DBVersion.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.