PolarDB:DescribeGlobalDatabaseNetworks-PolarDB-Alibaba Cloud - PolarDB

Mengkueri detail semua Global Database Networks (GDNs) di akun Anda.

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

get

*DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
FilterRegion	string	No	Hanya mengembalikan GDN yang mendukung pembuatan kluster sekunder di Wilayah yang ditentukan.	cn-beijing
DBClusterId	string	No	ID Kluster. Catatan Anda dapat memanggil operasi DescribeDBClusters untuk mengkueri ID semua Kluster di suatu Wilayah.	pc-**************
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 30. Nilai valid: 30 50	30
PageNumber	integer	No	Nomor halaman. Nilai harus lebih besar dari 0. Nilai default: 1.	1
GDNDescription	string	No	Deskripsi GDN. Deskripsi harus memenuhi persyaratan berikut: Tidak boleh diawali dengan `http://` atau `https://`. Harus diawali dengan huruf atau karakter Tionghoa. Dapat berisi huruf, karakter Tionghoa, angka, garis bawah (_), dan tanda hubung (-). Panjangnya harus 2 hingga 126 karakter.	test
GDNId	string	No	ID GDN.	gdn-****************
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-************

Elemen respons

Element	Type	Description	Example
	object
TotalRecordCount	integer	The total number of records.	1
PageRecordCount	integer	The number of records on the current page.	30
RequestId	string	The request ID.	69A85BAF-1089-4CDF-A82F-0A140F******
PageNumber	integer	The page number.	1
Items	array<object>	A list of GDNs.
	array<object>
DBVersion	string	The database engine version. Only version 8.0 is supported.	8.0
GDNId	string	The GDN ID.	gdn-****************
CreateTime	string	The time at which the GDN was created, in UTC. The format is `YYYY-MM-DDTHH:mm:ssZ`.	2020-03-23T05:46:54Z
GDNStatus	string	The status of the GDN. Valid values: creating: The GDN is being created. active: The GDN is running. deleting: The GDN is being deleted. locked: The GDN is locked. This status prevents any operations on clusters in the GDN. removing_member: A standby cluster is being removed from the GDN.	active
DBClusters	array<object>	A list of clusters in the GDN.
	object
DBClusterId	string	The cluster ID.	pc-****************
Role	string	The role of the cluster. Valid values: primary: The primary cluster. standby: The secondary cluster. Catatan A GDN contains one primary cluster and up to four secondary clusters. For more information, see Global Database Network (GDN).	primary
RegionId	string	The region ID.	cn-hangzhou
DBType	string	The database engine type. Only MySQL is supported.	MySQL
GDNDescription	string	The GDN description. Requirements: Cannot start with http:// or https://. Must start with a letter or a Chinese character. Can contain letters, Chinese characters, digits, underscores (_), or hyphens (-). Must be 2 to 126 characters long.	test
Labels	object	The tags applied to the GDN.
GDNVersion	string		2.0

Contoh

Respons sukses

JSONformat

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "PageNumber": 1,
  "Items": [
    {
      "DBVersion": "8.0",
      "GDNId": "gdn-****************",
      "CreateTime": "2020-03-23T05:46:54Z",
      "GDNStatus": "active",
      "DBClusters": [
        {
          "DBClusterId": "pc-****************",
          "Role": "primary",
          "RegionId": "cn-hangzhou"
        }
      ],
      "DBType": "MySQL",
      "GDNDescription": "test",
      "Labels": {
        "GDNVersion": "2.0"
      }
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
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.