DescribeDBClusterAttribute - PolarDB

Mengambil atribut dari kluster tertentu.

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 Panggil operasi DescribeDBClusters untuk menanyakan detail semua kluster dalam akun Anda, termasuk ID kluster tersebut.	pc-*****************
DescribeType	string	No	Menentukan apakah akan menanyakan informasi mengenai Node AI.	AI

Elemen respons

Element	Type	Description	Example
	object
DeletionLock	integer	Status kunci penghapusan kluster. Nilai yang valid: 0: Kluster tidak dikunci dan dapat dihapus. 1: Kluster dikunci dan tidak dapat dihapus.	0
Category	string	Edisi produk. Nilai yang valid: Normal: Edisi Kluster Basic: Edisi Node Tunggal Archive: X-Engine NormalMultimaster: Edisi Kluster Multi-master SENormal: Edisi Standar Catatan PolarDB for PostgreSQL (kompatibel dengan Oracle) yang menjalankan PostgreSQL 11 tidak mendukung edisi node tunggal. PolarDB for MySQL yang menjalankan MySQL 8.0 atau 5.7 dan PolarDB for PostgreSQL (kompatibel dengan Oracle) yang menjalankan PostgreSQL 14 mendukung Edisi Standar. PolarDB for MySQL yang menjalankan MySQL 8.0 mendukung 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 kernel menggunakan versi terbaru. Nilai yang valid: true false	false
HasCompleteStandbyRes	boolean	Menunjukkan apakah sumber daya database utama baru telah disediakan setelah failover lintas zona. Nilai yang valid: true false	false
HotStandbyCluster	string	Menunjukkan apakah klaster penyimpanan siaga panas (dan node komputasi siaga) diaktifkan. Nilai yang valid: StandbyClusterON: Klaster penyimpanan siaga panas atau kombinasi klaster penyimpanan siaga panas dan node komputasi siaga diaktifkan. StandbyClusterOFF: Klaster penyimpanan siaga panas atau kombinasi klaster penyimpanan siaga panas dan node komputasi siaga 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: diaktifkan OFF: dinonaktifkan	ON
StorageMax	integer	Kapasitas penyimpanan maksimum dari spesifikasi kluster saat ini. Satuan: byte.	10995116277760
DBVersion	string	Versi mesin database.	8.0
DBNodes	array<object>	Detail node.
	object
CreationTime	string	Waktu pembuatan node.	2020-03-23T21:35:43Z
FailoverPriority	integer	Prioritas failover. Setiap node memiliki prioritas failover. Nilai yang lebih besar menunjukkan prioritas yang lebih tinggi untuk dipromosikan menjadi node utama selama failover. Nilai yang valid: 1 hingga 15.	1
MaxIOPS	integer	Jumlah maksimum operasi input/output per detik (IOPS).	32000
DBNodeClass	string	Spesifikasi node.	polar.mysql.x4.large
CpuCores	string	Jumlah core CPU pada node.	2
MemorySize	string	Ukuran memori node. Satuan: MB.	8192
DBNodeRole	string	Peran node. Nilai yang valid: Writer: node utama. Reader: node read-only.	Reader
ZoneId	string	ID zona.	cn-hangzhou-i
MaxConnections	integer	Jumlah maksimum koneksi bersamaan ke kluster.	8000
DBNodeStatus	string	Status node. Nilai yang valid: Creating Running Deleting Rebooting DBNodeCreating: Sedang menambahkan node. DBNodeDeleting: Sedang menghapus node. ClassChanging: Spesifikasi node sedang diubah. NetAddressCreating: Sedang membuat koneksi jaringan. NetAddressDeleting: Sedang menghapus koneksi jaringan. NetAddressModifying: Sedang memodifikasi koneksi jaringan. MinorVersionUpgrading: Versi minor sedang ditingkatkan. Maintaining: Instans sedang dalam pemeliharaan. Switching: Alih bencana sedang berlangsung.	Running
DBNodeId	string	ID node.	pi-****************
ImciSwitch	string	Menunjukkan apakah fitur Indeks Kolom dalam Memori (IMCI) diaktifkan. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	ON
HotReplicaMode	string	Menunjukkan apakah fitur hot replica diaktifkan. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	ON
AddedCpuCores	string	Jumlah core CPU yang ditambahkan untuk fitur skalabilitas elastis dalam hitungan detik.	6
MasterId	string	ID node utama dalam kluster Edisi Kluster Multi-master.	pi-bp18z52akld3*****
SccMode	string	Menunjukkan apakah konsistensi global (mode kinerja tinggi) diaktifkan untuk node. Nilai yang valid: ON: diaktifkan OFF: dinonaktifkan	ON
ServerWeight	string	Bobot routing. Nilai yang valid: 1 hingga 100. Nilai default: 1.	1
ServerlessType	string	Tipe Serverless dari node. Nilai yang valid: AgileServerless: agile, yang menunjukkan node dengan spesifikasi yang ditentukan. SteadyServerless: steady, yang menunjukkan node Serverless. Catatan Parameter ini hanya didukung untuk kluster Serverless atau kluster dengan spesifikasi yang ditentukan yang telah mengaktifkan fitur Serverless.	SteadyServerless
SubCluster	string	Menunjukkan apakah node berada di zona utama atau zona sekunder. Parameter ini terutama digunakan untuk sumber daya peer. 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: on: diaktifkan off: dinonaktifkan	off
MultiMasterLocalStandby	string
MultiMasterPrimaryNode	string
DBNodeDescription	string	Deskripsi node.	test
SubGroupDescription	string
MirrorInsName	string	Nama node komputasi hot replica yang sesuai dengan node dalam arsitektur di mana penyimpanan hot standby dan komputasi hot standby diaktifkan.	pi-bp18z52mirror*****
DBNodeCXLRemoteMemory	string
ZoneIds	string	ID zona.	cn-hangzhou-i,cn-hangzhou-g
MaintainTime	string	Jendela pemeliharaan kluster. Waktu dalam format `HH:mmZ-HH:mmZ` dan dalam UTC. Contohnya, `16:00Z-17:00Z` menunjukkan bahwa pemeliharaan rutin dapat dilakukan dari pukul 00:00 hingga 01:00 (UTC+8).	18:00Z-19:00Z
Engine	string	Mesin kluster.	POLARDB
Tags	array<object>	Detail tag.
	object
Key	string	Kunci tag.	test
Value	string	Nilai tag.	MySQL
RequestId	string	ID permintaan.	074467EF-86B9-4C23-ACBF-E9B81A******
VPCId	string	ID virtual private cloud (VPC).	vpc-*******************
SearchClusterStatus	string
VSwitchId	string	ID virtual switch.	vsw-*********************
DBClusterDescription	string	Deskripsi kluster.	test
Expired	string	Menunjukkan apakah kluster telah kedaluwarsa. Catatan Parameter ini hanya dikembalikan untuk kluster langganan.	false
PayType	string	Metode penagihan. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: subscription.	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: Kluster tidak dikunci. ManualLock: Kluster dikunci secara manual. LockByExpiration: Kluster dikunci otomatis setelah kedaluwarsa.	Unlock
SearchStorageUsed	integer
SearchCompressStorageUsed	integer
StorageSpace	integer	storage space kluster langganan. Satuan: byte.	50
DBVersionStatus	string	Status versi mesin minor. Nilai yang valid: Stable: Versi saat ini stabil. Old: Versi saat ini lama. Kami menyarankan Anda meningkatkan kluster ke versi terbaru. HighRisk: Versi saat ini memiliki cacat kritis. Kami menyarankan Anda segera meningkatkan kluster ke versi terbaru. Beta: Versi saat ini adalah versi beta. Catatan Untuk informasi selengkapnya tentang cara meningkatkan versi mesin minor, lihat Upgrade versions. Parameter ini hanya dikembalikan ketika parameter DBType diatur ke MySQL.	Stable
CreationTime	string	Waktu pembuatan kluster.	2020-08-14T05:58:42Z
SQLSize	integer	Penggunaan penyimpanan untuk Pernyataan SQL. Satuan: byte. Nilai -1 menunjukkan bahwa tidak ada data yang tersedia.	0
InodeTotal	integer	Jumlah maksimum inode untuk sistem file.	6,291,456
InodeUsed	integer	Jumlah inode yang digunakan.	4,194,304
BlktagTotal	integer	Jumlah maksimum blktags untuk sistem file.	7,864,320
BlktagUsed	integer	Jumlah blktags yang digunakan.	5,242,880
RegionId	string	ID wilayah.	cn-hangzhou
ExpireTime	string	Waktu kedaluwarsa kluster. Catatan Parameter ini hanya dikembalikan untuk kluster langganan. Nilai kosong dikembalikan untuk kluster pay-as-you-go.	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: true false	false
StorageType	string	kelas penyimpanan. Nilainya tetap sebagai HighPerformance.	HighPerformance
ServerlessType	string	Tipe Serverless kluster. Nilai yang valid: AgileServerless: agile, yang menunjukkan kluster Serverless. SteadyServerless: steady, yang menunjukkan kluster dengan spesifikasi yang ditentukan yang telah mengaktifkan fitur Serverless. Catatan Parameter ini hanya didukung untuk kluster Serverless atau kluster dengan spesifikasi yang ditentukan yang telah mengaktifkan fitur Serverless.	SteadyServerless
StrictConsistency	string	Menunjukkan apakah konsistensi kuat diaktifkan untuk data multi-zona. Nilai yang valid: ON: Konsistensi kuat diaktifkan untuk data multi-zona. Ini berlaku untuk kluster Edisi Standar yang ditempatkan di tiga zona. OFF: Konsistensi kuat tidak diaktifkan untuk data multi-zona.	ON
ProxyCpuCores	string	Jumlah core CPU proksi database.	4
ProxyStandardCpuCores	string	Jumlah core CPU proksi database dengan spesifikasi standar.	2
ProxyType	string	Jenis proksi database. Nilai yang valid: Exclusive: Edisi Perusahaan Khusus General: Edisi Perusahaan Standar	Exclusive
ProxyStatus	string	Status proksi database. Nilai yang valid: Creating Running Deleting: Proksi sedang dilepas. Rebooting DBNodeCreating: Sedang menambahkan node. DBNodeDeleting: Sedang menghapus node. ClassChanging: Spesifikasi node sedang diubah. NetAddressCreating: Sedang membuat koneksi jaringan. NetAddressDeleting: Sedang menghapus koneksi jaringan. NetAddressModifying: Sedang memodifikasi koneksi jaringan. Deleted: Proksi telah dilepas.	Running
ProxyServerlessType	string	Tipe Serverless proksi database. Nilai yang valid: AgileServerless: agile, yang menunjukkan kluster Serverless. SteadyServerless: steady, yang menunjukkan kluster dengan spesifikasi yang ditentukan (kluster langganan atau pay-as-you-go).	SteadyServerless
Architecture	string	Arsitektur CPU. Nilai yang valid: X86 ARM	X86
AiType	string	Jenis node AI. Nilai yang valid: SearchNode: node pencarian. DLNode: Node AI.	DLNode
ProvisionedIops	string		2500
AiCreatingTime	string	Waktu mulai uji coba gratis untuk fitur AI.	2024-03-13T01:20:28Z
SupportInstantSwitchWithImci	string	Menunjukkan apakah fitur alih bencana instan yang kompatibel dengan IMCI didukung.	ON
Orca	string	Fitur Orca. Nilai yang valid: on: diaktifkan off: dinonaktifkan	ON
SourceDBCluster	string	ID kluster sumber. Catatan Parameter ini hanya didukung untuk kluster yang dipulihkan dari set cadangan atau titik waktu tertentu setelah 1 Juni 2024.	pc-pz51ziv48317b2880
RestoreType	string	Metode yang digunakan untuk memulihkan kluster. Nilai yang valid: RestoreByTime: Kluster dipulihkan ke titik waktu tertentu dari cadangan level-1. RestoreByBackupSet: Kluster dipulihkan dari set cadangan level-1. RestoreByTimeOss: Kluster dipulihkan ke titik waktu tertentu dari cadangan level-2. RestoreByBackupSetOss: Kluster dipulihkan dari set cadangan level-2. CloneFromSourceCluster: Kluster dikloning dari kluster sumber. Catatan Parameter ini hanya didukung untuk kluster yang dipulihkan dari set cadangan atau titik waktu tertentu setelah 1 Juni 2024.	RestoreByTime
RestoreDataPoint	string	Jika RestoreType diatur ke RestoreByTime atau RestoreByTimeOss, parameter ini menunjukkan titik waktu pemulihan. Jika RestoreType diatur ke RestoreByBackupSet atau RestoreByBackupSetOss, parameter ini menunjukkan ID set cadangan yang digunakan untuk pemulihan. Catatan Parameter ini hanya didukung untuk kluster yang dipulihkan dari set cadangan atau titik waktu tertentu setelah 1 Juni 2024.	2179639137
SourceRegionId	string	ID wilayah kluster sumber. Catatan Parameter ini hanya dikembalikan ketika ID kluster sumber tersedia.	cn-beijing
ImciAutoIndex	string	Fitur percepatan kueri berbasis IMCI otomatis. Nilai yang valid: `ON`: diaktifkan. `OFF`: dinonaktifkan.	OFF
AutoUpgradeMinorVersion	string	Metode untuk peningkatan versi minor. Auto: peningkatan otomatis Manual: peningkatan manual	Manual
BurstingEnabled	string	Menunjukkan apakah fitur lonjakan performa diaktifkan untuk ESSD AutoPL disk. Nilai yang valid: true: diaktifkan false: dinonaktifkan	false
RowCompression	string
ImperceptibleSwitch	string	Fitur alih bencana tak terasa. Nilai yang valid: `true`: diaktifkan. `false`: dinonaktifkan.
StorageUsed	integer	Ruang penyimpanan yang digunakan. Satuan: byte.	3012558848
CompressStorageUsed	integer	Ukuran data penyimpanan terkompresi. Catatan Parameter ini hanya dikembalikan ketika fitur kompresi penyimpanan diaktifkan untuk kluster.	15529410560
DBClusterStatus	string	Status kluster. Untuk informasi selengkapnya mengenai nilai yang valid, lihat Cluster states.	Running

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": "",
      "MultiMasterPrimaryNode": "",
      "DBNodeDescription": "test",
      "SubGroupDescription": "",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": ""
    }
  ],
  "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": "",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 0,
  "SearchCompressStorageUsed": 0,
  "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": "",
  "ImperceptibleSwitch": "",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running"
}

Kode kesalahan

HTTP status code	Error code	Error message
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.