PolarDB:DescribeDBClustersWithBackups - PolarDB - Alibaba Cloud - PolarDB

Mengkueri cluster PolarDB di suatu region yang memiliki set backup.

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

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	ID grup sumber daya.	rg-************
RegionId	string	Yes	ID region. Catatan Panggil operasi DescribeRegions untuk melihat detail tentang region.	cn-hangzhou
DBClusterIds	string	No	ID cluster. Anda dapat menentukan beberapa ID cluster. Pisahkan ID tersebut dengan koma (,).	pc-**************
DBClusterDescription	string	No	Nama cluster. Nama cluster harus memenuhi persyaratan berikut: Tidak boleh diawali dengan `http://` atau `https://`. Harus terdiri dari 2 hingga 256 karakter.	test
DBType	string	No	Tipe mesin database. Nilai yang valid: MySQL PostgreSQL Oracle	MySQL
IsDeleted	integer	No	Menentukan apakah cluster dihapus. Nilai yang valid: 0: Cluster tidak dihapus. 1: Cluster dihapus.	0
PageSize	integer	No	Jumlah catatan pada setiap halaman. Nilai yang valid: 30 50 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.	1
DBVersion	string	No	Versi mesin database. Nilai yang valid untuk MySQL: 5.6 5.7 8.0 Nilai yang valid untuk PostgreSQL: 11 14 Nilai yang valid untuk Oracle: 11 14	8.0

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	F8529AA2-522F-4B30-B80B-8F7D39******
PageNumber	integer	Nomor halaman.	1
PageRecordCount	integer	Jumlah cluster pada halaman saat ini.	1
TotalRecordCount	integer	Jumlah total entri yang dikembalikan.	1
Items	object
DBCluster	array<object>	Detail cluster.
	object
DeletedTime	string	The time when the cluster was deleted.	2022-05-12T03:25:37Z
VpcId	string	The VPC ID of the cluster.	vpc-******************
ExpireTime	string	The time when the cluster expires. Catatan A specific value will be returned only for subscription clusters. For pay-as-you-go clusters, an empty string will be returned.	2022-09-14T16:00:00Z
Expired	string	Indicates whether the cluster has expired. Catatan A specific value will be returned only for subscription clusters.	false
CreateTime	string	The time when the cluster was created.	2022-05-09T09:33:51Z
DBNodeClass	string	The specifications of the node.	polar.mysql.x4.medium
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription	Postpaid
DBType	string	The type of the database engine.	MySQL
LockMode	string	The state of the cluster lock. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked after the cluster expires.	Unlock
RegionId	string	The region ID of the cluster.	cn-hangzhou
DeletionLock	integer	Indicates whether the cluster is locked and can be deleted. Valid values: 0: The cluster is not locked and can be deleted. 1: The cluster is locked and cannot be deleted.	0
DBVersion	string	The version of the database engine.	8.0
DBClusterId	string	The ID of cluster.	pc-****************
DBClusterStatus	string	The status of the cluster. Valid values: Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being released. Rebooting: The cluster is restarting. DBNodeCreating: The node is being added. DBNodeDeleting: The node is being deleted. ClassChanging: The specifications of the node are being changed. NetAddressCreating: The network connection is being created. NetAddressDeleting: The network connection is being deleted. NetAddressModifying: The network connection is being modified. Deleted: The cluster has been released.	Running
IsDeleted	integer	Indicates whether the cluster was released. Valid values: 1: released 0: not released	1
DBClusterNetworkType	string	The network type of the cluster.	VPC
DBClusterDescription	string	The name of the cluster.	test
ZoneId	string	The ID of the zone in which the instance is located.	cn-hangzhou-h
Engine	string	The type of the database engine.	POLARDB

Contoh

Respons sukses

JSONformat

{
  "RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "Items": {
    "DBCluster": [
      {
        "DeletedTime": "2022-05-12T03:25:37Z",
        "VpcId": "vpc-******************",
        "ExpireTime": "2022-09-14T16:00:00Z",
        "Expired": "false",
        "CreateTime": "2022-05-09T09:33:51Z",
        "DBNodeClass": "polar.mysql.x4.medium",
        "PayType": "Postpaid",
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "8.0",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "IsDeleted": 1,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "POLARDB"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
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.