Kueri Kluster PolarDB Berdasarkan Zona dengan DescribeDBClustersZonal - PolarDB - Alibaba Cloud - PolarDB

Mencantumkan kluster PolarDB Basis Data Relasional Cloud-Native di MyBase.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

GET  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah.	cn-hangzhou
DBClusterIds	string	No	ID kluster. Untuk menentukan beberapa ID kluster, pisahkan 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.	Running
DBType	string	No	Tipe database. Nilai valid: MySQL PostgreSQL Oracle.	MySQL
DescribeType	string	No	Mode kueri. Atur nilainya ke `Simple`. Dalam mode ini, hanya metadata dasar kluster yang dikembalikan.	Simple
DBVersion	string	No	Versi 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. Nilai valid: 0 hingga 15.	6
Expired	string	No	Apakah kluster telah kedaluwarsa. Nilai valid: true false.	true
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai valid: 30, 50, dan 100. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai 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
Value	string	No	The value of the tag key.	5.6
Key	string	No	The key of tag `n`. You can filter clusters by specifying up to 20 tags. The `n` must be a unique and consecutive integer that starts from 1. `Tag.n.Key` corresponds to `Tag.n.Value`.	MySQL
PayType	string	No	Metode penagihan. Nilai valid: Postpaid: pay-as-you-go Prepaid: langganan.	Postpaid
DBNodeIds	string	No	ID node. Anda dapat menentukan beberapa ID node. Pisahkan dengan koma (,).	pi-***************
CloudProvider	string	No	Penyedia layanan cloud.	AlibabaCloud
MaxResults	integer	No	Jumlah maksimum entri yang dikembalikan untuk permintaan saat ini. Nilai default: 10.	10
NextToken	string	No	Token yang digunakan untuk mengambil halaman hasil berikutnya. Atur parameter ini ke nilai `NextToken` yang dikembalikan dari panggilan API sebelumnya. Anda tidak perlu menentukan parameter ini untuk panggilan pertama.	212db86sca4384811e0b5e8707e******

Elemen respons

Element	Type	Description	Example
	object
TotalRecordCount	integer	The total number of records.	16
PageRecordCount	integer	The number of clusters on the current page.	5
RequestId	string	The request ID.	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	The page number.	12
Items	array<object>	The list of clusters.
	array<object>
Category	string	The Cluster Edition. The following editions are supported: Normal: Cluster Edition Basic: single node Archive: X-Engine NormalMultimaster: Multi-master Cluster (Database/Table)	Normal
DBClusterId	string	The cluster ID.	pc-****************
DBType	string	The database type.	MySQL
CentralControlRegionId	string	The ID of the central control region.	cn-beijing
DBVersion	string	The database version.	5.6
CloudProvider	string	The cloud service provider.	ENS
Tags	array<object>	The list of tags.
	object
Value	string	The tag value.	5.6
Key	string	The tag key.	MySQL
StorageType	string	The storage class of the Standard Edition cluster. Valid values: essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
ZoneId	string	The zone ID.	cn-hangzhou-i
DBClusterStatus	string	The status of the cluster.	Running
CreateTime	string	The creation time.	2020-08-14T05:58:42Z
DBClusterDescription	string	The description of the cluster.	GDN-1
Expired	string	Indicates whether the cluster has expired. Valid values: true false	false
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
LockMode	string	The lock state of the cluster. Valid values: Unlock: Normal. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked upon expiration.	Unlock
VswitchId	string	The virtual switch ID.	vsw-***************
StrictConsistency	string	Indicates whether strong consistency is enabled for data across multiple zones. Valid values: ON: Strong consistency is enabled. This applies to Standard Edition clusters that are deployed in three zones. OFF: Strong consistency is not enabled.	ON
DBNodeClass	string	The node specifications.	polar.mysql.g1.tiny.c
StorageUsed	integer	The used storage space of the cluster. Unit: bytes.	3009413120
ENSRegionId	string	The ENS region ID.	sg-singapore-9
DBNodeNumber	integer	The number of nodes.	2
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-****************
StorageSpace	integer	The storage capacity of the instance.	10
ServerlessType	string	The Serverless type. `AgileServerless` indicates that the cluster is a Serverless cluster. An empty value indicates that the cluster is a common cluster.	AgileServerless
AiType	string	The AI node type. Valid values: SearchNode: search node DLNode: AI node	SearchNode
CpuCores	string	The number of CPU cores.	1
SubCategory	string	The specification type of the compute node. Valid values: Exclusive: Dedicated General: General-purpose	Exclusive
ExpireTime	string	The expiration time of the cluster. Catatan This parameter is returned only for Prepaid (subscription) clusters. For Postpaid (pay-as-you-go) clusters, this parameter is empty.	2022-09-14T16:00:00Z
MaxResults	integer	The maximum number of entries returned for the current request. Default value: 10.	10
NextToken	string	The token to retrieve the next page of results. If more results are available, this parameter is returned. To retrieve the next page, include this token in your next request. If all results have been returned, this parameter is not returned.	212db86sca4384811e0b5e8707e******

Contoh

Respons sukses

JSONformat

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": [
    {
      "Category": "Normal",
      "DBClusterId": "pc-****************",
      "DBType": "MySQL",
      "CentralControlRegionId": "cn-beijing",
      "DBVersion": "5.6",
      "CloudProvider": "ENS",
      "Tags": [
        {
          "Value": "5.6",
          "Key": "MySQL"
        }
      ],
      "StorageType": "essdautopl",
      "ZoneId": "cn-hangzhou-i",
      "DBClusterStatus": "Running",
      "CreateTime": "2020-08-14T05:58:42Z",
      "DBClusterDescription": "GDN-1",
      "Expired": "false",
      "PayType": "Prepaid",
      "LockMode": "Unlock",
      "VswitchId": "vsw-***************",
      "StrictConsistency": "ON",
      "DBNodeClass": "polar.mysql.g1.tiny.c",
      "StorageUsed": 3009413120,
      "ENSRegionId": "sg-singapore-9",
      "DBNodeNumber": 2,
      "VpcId": "vpc-****************",
      "StorageSpace": 10,
      "ServerlessType": "AgileServerless",
      "AiType": "SearchNode",
      "CpuCores": "1",
      "SubCategory": "Exclusive",
      "ExpireTime": "2022-09-14T16:00:00Z"
    }
  ],
  "MaxResults": 10,
  "NextToken": "212db86sca4384811e0b5e8707e******"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.