Gunakan DescribeDBClusterAttribute untuk mengkueri atribut kluster - PolarDB - Alibaba Cloud - PolarDB

Mengambil informasi atribut suatu kluster.

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

get

*DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster. Catatan Anda dapat memanggil operasi DescribeDBClusters untuk menanyakan detail semua kluster di bawah akun Anda, termasuk ID kluster.	pc-*****************
DescribeType	string	No	Menentukan apakah akan mengambil informasi node terkait AI.	AI

Elemen respons

Element	Type	Description	Example
	object
DeletionLock	integer	Status kunci penghapusan kluster. Nilai yang valid: 0: Tidak terkunci. Kluster dapat dihapus. 1: Terkunci. Kluster tidak dapat dihapus.	0
Category	string	Edisi produk. Nilai yang valid: Normal: Edisi Kluster Basic: Edisi Node Tunggal Archive: Edisi PolarDB X-Engine NormalMultimaster: Edisi Kluster Multi-master SENormal: PolarDB untuk MySQL Edisi Standar Catatan PolarDB for PostgreSQL 11 tidak mendukung Edisi Node Tunggal. PolarDB for MySQL 8.0, PolarDB for MySQL 5.7, dan PolarDB for PostgreSQL 14 mendukung PolarDB untuk MySQL Edisi Standar. PolarDB for MySQL 8.0 mendukung Edisi PolarDB X-Engine dan Edisi Kluster Multi-master.	Normal
ResourceGroupId	string	ID kelompok sumber daya.	rg-***************
DataLevel1BackupChainSize	integer	Total ukuran cadangan level-1 (Snapshot). Satuan: byte.	74448896
DBClusterId	string	ID kluster.	pc-*****************
DBType	string	Jenis mesin database.	MySQL
DBClusterNetworkType	string	Jenis jaringan kluster.	VPC
IsLatestVersion	boolean	Menunjukkan apakah kluster menjalankan versi kernel terbaru. Nilai yang valid:	false
HasCompleteStandbyRes	boolean	Menunjukkan apakah sumber daya untuk database utama baru telah diisi ulang setelah failover lintas zona. Nilai yang valid: true: Sumber daya telah diisi ulang. false: Sumber daya belum diisi ulang.	false
HotStandbyCluster	string	Menunjukkan apakah klaster penyimpanan siaga panas (dan node komputasi Standby) diaktifkan. Nilai yang valid: StandbyClusterON: Klaster penyimpanan siaga panas dan node komputasi Standby diaktifkan. StandbyClusterOFF: Klaster penyimpanan siaga panas dan node komputasi Standby dinonaktifkan.	StandbyClusterON
DataSyncMode	string	Mode replikasi data. Nilai yang valid: AsyncSync: asinkron SemiSync: semi-sinkron	AsyncSync
StandbyHAMode	string	Mode pemulihan bencana lintas zona. Nilai yang valid: ON: Mode pemulihan bencana lintas zona diaktifkan. OFF: Mode pemulihan bencana lintas zona dinonaktifkan. 0: Mode simulasi pelanggan.	OFF
CompressStorageMode	string	Menunjukkan apakah kompresi penyimpanan diaktifkan. Nilai yang valid:	ON
StorageMax	integer	Kapasitas penyimpanan maksimum untuk spesifikasi kluster saat ini. Satuan: byte.	10995116277760
DBVersion	string	Versi mesin database.	8.0
DBNodes	array<object>	Informasi node.
	object
CreationTime	string	Waktu pembuatan node.	2020-03-23T21:35:43Z
FailoverPriority	integer	Prioritas failover. Setiap node memiliki prioritas failover yang menentukan probabilitas node tersebut dipilih sebagai node utama selama failover. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi. Nilai yang valid: 1 hingga 15.	1
MaxIOPS	integer	Jumlah maksimum permintaan I/O per detik (IOPS).	32000
DBNodeClass	string	Spesifikasi node.	polar.mysql.x4.large
CpuCores	string	Jumlah core CPU node.	2
MemorySize	string	Ukuran memori node. Satuan: MB.	8192
DBNodeRole	string	Peran node. Nilai yang valid:	Reader
ZoneId	string	ID zona.	cn-hangzhou-i
MaxConnections	integer	Jumlah maksimum koneksi bersamaan ke kluster.	8000
DBNodeStatus	string	Status node. Nilai yang valid:	Running
DBNodeId	string	ID node.	pi-****************
ImciSwitch	string	Menunjukkan apakah In-Memory Column Index diaktifkan. Nilai yang valid:	ON
HotReplicaMode	string	Menunjukkan apakah hot standby diaktifkan. Nilai yang valid:	ON
AddedCpuCores	string	Jumlah core CPU yang ditambahkan melalui penskalaan otomatis sumber daya lokal.	6
MasterId	string	ID node utama pada Edisi Kluster Multi-master.	pi-bp18z52akld3*****
SccMode	string	Menunjukkan apakah fitur konsistensi global (mode kinerja tinggi) diaktifkan untuk node. Nilai yang valid:	ON
ServerWeight	string	Bobot routing.	1
ServerlessType	string	Jenis serverless node. Nilai yang valid: AgileServerless: serverless agile. Node ini merupakan node serverless. SteadyServerless: serverless stabil. Node ini merupakan node dengan spesifikasi yang ditentukan yang memiliki fitur serverless diaktifkan. Catatan Parameter ini hanya didukung untuk kluster serverless atau kluster dengan spesifikasi yang ditentukan yang memiliki fitur serverless diaktifkan. Untuk informasi lebih lanjut, lihat Serverless.	SteadyServerless
SubCluster	string	Menunjukkan apakah node berada di zona utama atau zona sekunder. Parameter ini terutama digunakan untuk penerapan simetris sumber daya. Nilai yang valid: Primary: zona utama. Standby: zona sekunder.	Primary
RemoteMemorySize	string	Ukuran memori remote. Satuan: MB.	3072
Orca	string	Fitur Orca. Nilai yang valid:	off
MultiMasterLocalStandby	string	Node standby lokal multi-master.	pi-****************
MultiMasterPrimaryNode	string	Node utama multi-master.	pi-****************
DBNodeDescription	string	Deskripsi node.	test
SubGroupDescription	string	Deskripsi subgrup kluster.	test Description
MirrorInsName	string	Nama hot replica yang sesuai dengan node dalam arsitektur penyimpanan dan komputasi siaga panas.	pi-bp18z52mirror*****
DBNodeCXLRemoteMemory	string	Konfigurasi memori remote CXL.	3072
RemoteMemoryMin	integer
RemoteMemoryMax	integer
RemoteMemoryRecommended	integer
DedicatedHostModel	boolean
ZoneIds	string	ID zona.	cn-hangzhou-i,cn-hangzhou-g
MaintainTime	string	Jendela pemeliharaan kluster. Waktu dalam format `HH:mmZ-HH:mmZ` (UTC). Contohnya, `16:00Z-17:00Z` menunjukkan bahwa pemeliharaan rutin dapat dilakukan dari pukul 00:00 hingga 01:00 (UTC+08:00).	18:00Z-19:00Z
Engine	string	Mesin kluster.	POLARDB
Tags	array<object>	Informasi tag.
	object
Key	string	Kunci tag.	test
Value	string	Nilai tag.	MySQL
RequestId	string	ID permintaan.	074467EF-86B9-4C23-ACBF-E9B81A******
VPCId	string	ID VPC.	vpc-*******************
SearchClusterStatus	string	Status berjalan node pencarian.	Running
VSwitchId	string	ID vSwitch.	vsw-*********************
DBClusterDescription	string	Deskripsi kluster.	test
Expired	string	Menunjukkan apakah kluster telah kedaluwarsa.	false
PayType	string	Metode penagihan. Nilai yang valid:	Prepaid
StoragePayType	string	Metode penagihan untuk penyimpanan. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
LockMode	string	Mode kunci. Nilai yang valid:	Unlock
SearchStorageUsed	integer	Penggunaan penyimpanan node pencarian.	3012558848
SearchCompressStorageUsed	integer	Ukuran data penyimpanan terkompresi node pencarian.	15529410560
StorageSpace	integer	Storage space yang ditagih berdasarkan ruang (subscription). Satuan: byte.	50
DBVersionStatus	string	Status versi minor saat ini. Nilai yang valid: Stable: Versi saat ini stabil. Old: Versi saat ini sudah usang. Lakukan peningkatan ke versi terbaru. HighRisk: Versi saat ini memiliki cacat kritis. Segera lakukan peningkatan ke versi terbaru. Beta: Versi saat ini adalah versi Beta. Catatan Untuk informasi lebih lanjut tentang cara meningkatkan versi minor, lihat Peningkatan versi. Parameter ini hanya dikembalikan ketika jenis mesin database (DBType) adalah MySQL.	Stable
CreationTime	string	Waktu pembuatan kluster.	2020-08-14T05:58:42Z
SQLSize	integer	Ukuran penyimpanan pernyataan SQL. Satuan: byte. Nilai -1 menunjukkan tidak ada data yang tersedia.	0
InodeTotal	integer	Jumlah maksimum inode dalam sistem file.	6,291,456
InodeUsed	integer	Penggunaan inode saat ini.	4,194,304
BlktagTotal	integer	Jumlah maksimum blktags dalam sistem file.	7,864,320
BlktagUsed	integer	Penggunaan blktag saat ini.	5,242,880
RegionId	string	ID wilayah.	cn-hangzhou
ExpireTime	string	Waktu kedaluwarsa kluster. Catatan Hanya kluster dengan metode penagihan Prepaid (subscription) yang mengembalikan nilai spesifik untuk parameter ini. Kluster Postpaid (pay-as-you-go) mengembalikan nilai kosong.	2020-11-14T16:00:00Z
SubCategory	string	Jenis spesifikasi node komputasi. Nilai yang valid: Exclusive: Dedicated General: General-purpose Catatan Parameter ini hanya dikembalikan untuk kluster PolarDB for MySQL Edisi Kluster.	Exclusive
IsProxyLatestVersion	boolean	Menunjukkan apakah proksi database menggunakan versi terbaru. Nilai yang valid:	false
StorageType	string	Jenis penyimpanan. Nilainya tetap sebagai HighPerformance.	HighPerformance
ServerlessType	string	Jenis serverless kluster. Nilai yang valid: AgileServerless: serverless agile. Nilai ini menunjukkan kluster serverless. SteadyServerless: serverless stabil. Nilai ini menunjukkan kluster dengan spesifikasi yang ditentukan yang memiliki fitur serverless diaktifkan. Catatan Parameter ini hanya didukung untuk kluster serverless atau kluster dengan spesifikasi yang ditentukan yang memiliki fitur serverless diaktifkan.	SteadyServerless
StrictConsistency	string	Menunjukkan apakah konsistensi data kuat multi-zona diaktifkan untuk kluster. Nilai yang valid:	ON
ProxyCpuCores	string	Jumlah core CPU proksi database.	4
ProxyStandardCpuCores	string	Jumlah core CPU dalam konfigurasi standar proksi database.	2
ProxyType	string	Jenis proksi database. Nilai yang valid:	Exclusive
ProxyStatus	string	Status proksi database. Nilai yang valid:	Running
ProxyServerlessType	string	Jenis serverless proksi database. Nilai yang valid: AgileServerless: serverless agile, yang menunjukkan kluster serverless. SteadyServerless: serverless stabil, yang menunjukkan kluster dengan spesifikasi yang ditentukan (kluster subscription atau pay-as-you-go).	SteadyServerless
Architecture	string	Arsitektur CPU. Nilai yang valid:	X86
AiType	string	Jenis node AI. Nilai yang valid:	DLNode
ProvisionedIops	string		2500
AiCreatingTime	string	Waktu mulai fitur AI gratis.	2024-03-13T01:20:28Z
SupportInstantSwitchWithImci	string	Menunjukkan apakah fitur failover dengan replika panas yang kompatibel dengan IMCI didukung.	ON
Orca	string	Fitur Orca. Nilai yang valid:	ON
SourceDBCluster	string	ID kluster sumber. Catatan Parameter ini hanya didukung untuk kluster yang dipulihkan dari set cadangan atau titik waktu setelah 1 Juni 2024.	pc-pz51ziv48317b2880
RestoreType	string	Metode pemulihan kluster. Nilai yang valid: RestoreByTime: Memulihkan dari titik waktu berdasarkan cadangan level-1. RestoreByBackupSet: Memulihkan dari set cadangan berdasarkan cadangan level-1. RestoreByTimeOss: Memulihkan dari titik waktu berdasarkan cadangan level-2. RestoreByBackupSetOss: Memulihkan dari set cadangan berdasarkan cadangan level-2. CloneFromSourceCluster: Mengkloning dari kluster sumber. Catatan Parameter ini hanya didukung untuk kluster yang dipulihkan dari set cadangan atau titik waktu setelah 1 Juni 2024.	RestoreByTime
RestoreDataPoint	string	Jika RestoreType adalah RestoreByTime atau RestoreByTimeOss, nilai ini menunjukkan titik waktu tujuan pemulihan kluster. Jika RestoreType adalah RestoreByBackupSet atau RestoreByBackupSetOss, nilai ini menunjukkan ID set cadangan tempat kluster dipulihkan. Catatan Parameter ini hanya didukung untuk kluster yang dipulihkan dari set cadangan atau ke titik waktu setelah 1 Juni 2024.	2179639137
SourceRegionId	string	ID wilayah kluster sumber.	cn-beijing
ImciAutoIndex	string	Fitur percepatan kueri berbasis IMCI otomatis. Nilai yang valid:	OFF
AutoUpgradeMinorVersion	string	Kebijakan pembaruan versi minor.	Manual
BurstingEnabled	string	Menunjukkan apakah lonjakan performa I/O diaktifkan untuk disk cloud ESSD AutoPL. Nilai yang valid:	false
RowCompression	string	Pengaturan kompresi baris.	OFF
ImperceptibleSwitch	string	Fitur failover dengan replika panas. Nilai yang valid:	true
StorageUsed	integer	Penggunaan penyimpanan. Satuan: byte.	3012558848
CompressStorageUsed	integer	Ukuran data penyimpanan setelah dikompresi.	15529410560
DBClusterStatus	string	Status kluster. Untuk informasi lebih lanjut, lihat Tabel status kluster.	Running
Branch	object
ParentInsName	string
BranchTime	string
BranchLsn	string
ChildBranch	array<object>
	object
InsName	string
DBClusterDescription	string
BranchTime	string
BranchLsn	string
HasChild	boolean
ColumnTable	string	Menunjukkan apakah tabel penyimpanan kolom diaktifkan.	OFF
ConnectionResourceQuota	integer	Kuota sumber daya koneksi (eksklusif AgenticDB).
ConnectionResourceUsed	integer	Jumlah sumber daya koneksi yang digunakan (eksklusif AgenticDB).
StorageUpperBound	integer
StorageAutoScale	string

Contoh

Respons sukses

JSONformat

{
  "DeletionLock": 0,
  "Category": "Normal",
  "ResourceGroupId": "rg-***************",
  "DataLevel1BackupChainSize": 74448896,
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL",
  "DBClusterNetworkType": "VPC",
  "IsLatestVersion": false,
  "HasCompleteStandbyRes": false,
  "HotStandbyCluster": "StandbyClusterON",
  "DataSyncMode": "AsyncSync",
  "StandbyHAMode": "OFF",
  "CompressStorageMode": "ON",
  "StorageMax": 10995116277760,
  "DBVersion": "8.0",
  "DBNodes": [
    {
      "CreationTime": "2020-03-23T21:35:43Z",
      "FailoverPriority": 1,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "CpuCores": "2",
      "MemorySize": "8192",
      "DBNodeRole": "Reader",
      "ZoneId": "cn-hangzhou-i",
      "MaxConnections": 8000,
      "DBNodeStatus": "Running",
      "DBNodeId": "pi-****************",
      "ImciSwitch": "ON",
      "HotReplicaMode": "ON",
      "AddedCpuCores": "6",
      "MasterId": "pi-bp18z52akld3*****",
      "SccMode": "ON",
      "ServerWeight": "1",
      "ServerlessType": "SteadyServerless",
      "SubCluster": "Primary",
      "RemoteMemorySize": "3072",
      "Orca": "off",
      "MultiMasterLocalStandby": "pi-****************",
      "MultiMasterPrimaryNode": "pi-****************",
      "DBNodeDescription": "test",
      "SubGroupDescription": "test Description",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": "3072",
      "RemoteMemoryMin": 0,
      "RemoteMemoryMax": 0,
      "RemoteMemoryRecommended": 0,
      "DedicatedHostModel": false
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Key": "test",
      "Value": "MySQL"
    }
  ],
  "RequestId": "074467EF-86B9-4C23-ACBF-E9B81A******",
  "VPCId": "vpc-*******************",
  "SearchClusterStatus": "Running",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 3012558848,
  "SearchCompressStorageUsed": 15529410560,
  "StorageSpace": 50,
  "DBVersionStatus": "Stable",
  "CreationTime": "2020-08-14T05:58:42Z",
  "SQLSize": 0,
  "InodeTotal": 0,
  "InodeUsed": 0,
  "BlktagTotal": 0,
  "BlktagUsed": 0,
  "RegionId": "cn-hangzhou",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "SubCategory": "Exclusive",
  "IsProxyLatestVersion": false,
  "StorageType": "HighPerformance",
  "ServerlessType": "SteadyServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "SteadyServerless",
  "Architecture": "X86",
  "AiType": "DLNode",
  "ProvisionedIops": "2500",
  "AiCreatingTime": "2024-03-13T01:20:28Z",
  "SupportInstantSwitchWithImci": "ON",
  "Orca": "ON",
  "SourceDBCluster": "pc-pz51ziv48317b2880",
  "RestoreType": "RestoreByTime",
  "RestoreDataPoint": "2179639137",
  "SourceRegionId": "cn-beijing",
  "ImciAutoIndex": "OFF",
  "AutoUpgradeMinorVersion": "Manual",
  "BurstingEnabled": "false",
  "RowCompression": "OFF\n",
  "ImperceptibleSwitch": "true",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running",
  "Branch": {
    "ParentInsName": "",
    "BranchTime": "",
    "BranchLsn": "",
    "ChildBranch": [
      {
        "InsName": "",
        "DBClusterDescription": "",
        "BranchTime": "",
        "BranchLsn": "",
        "HasChild": false
      }
    ]
  },
  "ColumnTable": "OFF",
  "ConnectionResourceQuota": 0,
  "ConnectionResourceUsed": 0,
  "StorageUpperBound": 0,
  "StorageAutoScale": ""
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	Operasi gagal. ID instans kluster yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.