Kueri Daftar Kluster PolarDB Kustom via DescribeAIDBClusters - PolarDB - Alibaba Cloud - PolarDB

Mengkueri klaster kustom.

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

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterIds	string	No	ID klaster. Untuk menentukan beberapa klaster, pisahkan ID-nya dengan koma (,).	pc-***************
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 30, 50, dan 100. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman.	1
DBClusterDescription	string	No	Deskripsi klaster. Pencarian fuzzy didukung.	pc-****************
DBClusterStatus	string	No	Status klaster. Nilai yang valid: Creating: Klaster sedang dibuat. Running: Klaster sedang berjalan. Deleting: Klaster sedang dirilis. Rebooting: Klaster sedang dimulai ulang. DBNodeCreating: Node sedang ditambahkan. DBNodeDeleting: Node sedang dihapus. ClassChanging: Spesifikasi node sedang diubah. NetAddressCreating: Koneksi jaringan sedang dibuat. NetAddressDeleting: Koneksi jaringan sedang dihapus. NetAddressModifying: Koneksi jaringan sedang dimodifikasi. Deleted: Klaster telah dirilis. ClassChanged: Sumber daya sedang diklaim kembali setelah peningkatan atau penurunan versi.	Running
PayType	string	No	Metode penagihan. Nilai yang valid: Postpaid: bayar sesuai pemakaian. Prepaid: langganan.	Prepaid
RegionId	string	Yes	ID region.	cn-hangzhou
AiNodeType	string	No	Jenis node. Untuk menentukan beberapa jenis, pisahkan dengan koma (,). Nilai yang valid: vnode: node yang dikelola oleh Kubernetes. container: kontainer yang dapat Anda log masuk. maas: layanan model.	vnode,container
Tag	array<object>	No	Daftar tag.
	object	No
Key	string	No	Kunci tag. Gunakan parameter ini bersama `Tag.n.Value` untuk memfilter klaster berdasarkan tag. Anda dapat menentukan hingga 20 pasangan tag. Indeks n harus berupa bilangan bulat unik dan berurutan yang dimulai dari 1.	testKey
Value	string	No	Nilai tag.	testValueData

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
RequestId	string	ID permintaan.	9D6CE7C6-1C52-5BF6-B3D7-10977D44542C
TotalRecordCount	integer	Jumlah total entri.	5
PageRecordCount	integer	Jumlah entri pada halaman saat ini.	7
PageNumber	integer	Nomor halaman. Nilai default: 1.	1
Items	object	Detail klaster AI.
DBCluster	array<object>	Daftar instance klaster AI.
	array<object>	Properti instance klaster AI.
DBClusterId	string	The cluster ID.	pc-**************
RegionId	string	The region ID.	cn-hangzhou
ZoneId	string	The zone ID.	cn-hangzhou-j
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DBClusterStatus	string	The cluster status.	Creating
DBClusterDescription	string	The cluster description.	ocpx
VpcId	string	The ID of the virtual private cloud (VPC) where the endpoint is located.	vpc-***************
DBNodeClass	string	The node specifications.	polar.pg.g8.8xlarge.gu30
StorageType	string	The storage class. Valid values: essdpl0 essdpl1 essdpl2 essdpl3	essdpl0
StorageSpace	integer	The storage space after the change. Unit: GB.	10
ExpireTime	string	The expiration time. Catatan This parameter is returned only for subscription clusters. For pay-as-you-go clusters, an empty value is returned.	2028-09-01T16:00:00Z
Expired	boolean	Indicates whether the cluster has expired. Valid values: true false	False
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
CreateTime	string	The time when the cluster was created.	2021-09-13T15:45:27Z
KubeClusterId	string	The ACK cluster ID.	xxxxxxxxxxxx
RunType	string	The run type. Valid values: container: A container. default: A node.	container
DBType	string	The database engine type. Only polardb_ai is supported.	polardb_ai
AiNodeType	string	The node type. Valid values: vnode: A node managed by Kubernetes. container: A container that you can log on to. maas: A model service.	vnode
Tags	object
Tag	array<object>
	object
Key	string		testKey
Value	string		testValueData
VswitchId	string		vsw-**************
RelativeDBClusterId	string		pc-**************
ModelType	string		custom

Contoh

Respons sukses

JSONformat

{
  "RequestId": "9D6CE7C6-1C52-5BF6-B3D7-10977D44542C",
  "TotalRecordCount": 5,
  "PageRecordCount": 7,
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DBClusterId": "pc-**************",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-j",
        "PayType": "Postpaid",
        "DBClusterStatus": "Creating",
        "DBClusterDescription": "ocpx",
        "VpcId": "vpc-***************",
        "DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
        "StorageType": "essdpl0",
        "StorageSpace": 10,
        "ExpireTime": "2028-09-01T16:00:00Z",
        "Expired": true,
        "LockMode": "Unlock",
        "CreateTime": "2021-09-13T15:45:27Z",
        "KubeClusterId": "xxxxxxxxxxxx",
        "RunType": "container",
        "DBType": "polardb_ai",
        "AiNodeType": "vnode",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValueData"
            }
          ]
        },
        "VswitchId": "vsw-**************",
        "RelativeDBClusterId": "pc-**************",
        "ModelType": "custom"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.