DescribeGlobalDatabaseNetwork - PolarDB

Menjelaskan detail Global Database Network (GDN).

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

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
GDNId	string	Yes	ID GDN.	gdn-bp1fttxsrmv*****
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-************

Elemen respons

Element	Type	Description	Example
	object
GDNStatus	string	Status GDN. Nilai yang valid: creating: GDN sedang dibuat. active: GDN sedang berjalan. deleting: GDN sedang dihapus. locked: GDN terkunci. Anda tidak dapat melakukan operasi apa pun pada kluster dalam GDN. removing_member: Kluster secondary sedang dihapus dari GDN.	active
Connections	array<object>	Informasi koneksi.
	object
ConnectionString	string	String koneksi.	abc.polardb.rds.aliyuncs.com
NetType	string	Jenis jaringan.	Private
Port	string	Nomor port dari string koneksi.	3306
DBVersion	string	Versi mesin database. Hanya versi 8.0 yang didukung.	8.0
RequestId	string	ID permintaan.	67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNId	string	ID GDN.	gdn-bp1fttxsrmv*****
CreateTime	string	Waktu saat GDN dibuat.	2020-02-24T11:57:54Z
DBType	string	Jenis mesin database. Hanya MySQL yang didukung.	MySQL
GDNDescription	string	Deskripsi GDN. Deskripsi harus memenuhi persyaratan berikut: Tidak boleh diawali dengan http:// atau https://. Harus diawali dengan huruf. Dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Panjangnya harus antara 2 hingga 126 karakter.	GDN-fortest
GlobalDomainName	string	Nama domain global.	[gdnid].gdn.rds.aliyuncs.com
DBClusters	array<object>	Kluster dalam GDN.
	array<object>
ReplicaLag	string	Delay replikasi lintas wilayah antara kluster utama dan kluster sekunder. Satuan: detik.	1
ExpireTime	string	Waktu kedaluwarsa kluster. Catatan Parameter ini hanya dikembalikan untuk kluster langganan. Nilai kosong dikembalikan untuk kluster bayar sesuai pemakaian.	2020-11-14T16:00:00Z
Expired	string	Menunjukkan apakah kluster telah kedaluwarsa. true: Kluster telah kedaluwarsa. false: Kluster belum kedaluwarsa. Catatan Parameter ini hanya dikembalikan untuk kluster langganan.	false
DBNodeClass	string	Spesifikasi node database.	polar.mysql.x4.large
PayType	string	Metode penagihan: Postpaid: bayar sesuai pemakaian. Prepaid: langganan.	Prepaid
DBType	string	Jenis mesin database. Hanya MySQL yang didukung.	MySQL
RegionId	string	ID wilayah.	cn-hangzhou
DBVersion	string	Versi mesin database. Hanya versi 8.0 yang didukung.	8.0
DBClusterId	string	ID kluster dalam GDN.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	Status kluster dalam GDN. Untuk informasi selengkapnya, lihat Cluster states.	Running
StorageUsed	string	Ruang storage space yang digunakan. Satuan: byte.	3012558848
DBClusterDescription	string	Deskripsi kluster.	test
Category	string	Edisi kluster. Nilai yang valid: Normal: Edisi Kluster Basic: Edisi Single-node Archive: Edisi X-Engine NormalMultimaster: Edisi Kluster Multi-master SENormal: Edisi Standar Catatan Edisi single-node tidak didukung untuk kluster PolarDB for PostgreSQL yang menjalankan PostgreSQL 11. Edisi Standar didukung untuk kluster PolarDB for MySQL yang menjalankan MySQL 8.0 atau 5.7 dan untuk kluster PolarDB for PostgreSQL yang menjalankan PostgreSQL 14. Edisi X-Engine dan Edisi Kluster Multi-master didukung untuk kluster PolarDB for MySQL yang menjalankan MySQL 8.0.	Normal
Role	string	Peran kluster. Nilai yang valid: primary: Kluster utama. standby: Kluster sekunder. Catatan GDN berisi satu kluster utama dan maksimal empat kluster sekunder.	primary
ServerlessType	string	Jenis kluster Serverless. Nilainya tetap AgileServerless. Catatan Parameter ini hanya didukung untuk kluster Serverless.	AgileServerless
DBNodes	array<object>	Detail node database.
	object
DBNodeClass	string	Spesifikasi node database.	polar.mysql.x4.large
ZoneId	string	ID zona.	cn-hangzhou-i
CreationTime	string	Waktu saat node database dibuat.	2020-03-23T21:35:43Z
DBNodeRole	string	Peran node database. Nilai yang valid: Writer: Node utama. Reader: Node read-only.	Reader
DBNodeStatus	string	Status node. Nilai yang valid: Creating: Node sedang dibuat. Running: Node sedang berjalan. Deleting: Node sedang dihapus. Rebooting: Node sedang direstart. ClassChanging: Spesifikasi node sedang diubah. NetAddressCreating: Koneksi jaringan sedang dibuat. NetAddressDeleting: Koneksi jaringan sedang dihapus. NetAddressModifying: Koneksi jaringan sedang dimodifikasi. MinorVersionUpgrading: Versi minor sedang diperbarui. Maintaining: Kluster sedang dalam pemeliharaan. Switching: Alih bencana sedang berlangsung.	Running
FailoverPriority	integer	Prioritas failover. Setiap node memiliki prioritas failover. Prioritas yang lebih tinggi menunjukkan kemungkinan lebih besar bahwa node tersebut dipilih sebagai node utama selama failover. Nilainya dapat berupa bilangan bulat dari 1 hingga 15.	1
MaxConnections	integer	Jumlah maksimum koneksi bersamaan ke kluster.	8000
MaxIOPS	integer	Jumlah maksimum operasi input/output per detik (IOPS).	32000
DBNodeId	string	ID node database.	pi-****************
DBClusterId	string	ID kluster.	pc-bp1s826a1up******
ResourceGroupId	string	ID kelompok sumber daya.	rg-************
Labels	object
GDNVersion	string

Contoh

Respons sukses

JSONformat

{
  "GDNStatus": "active",
  "Connections": [
    {
      "ConnectionString": "abc.polardb.rds.aliyuncs.com",
      "NetType": "Private",
      "Port": "3306"
    }
  ],
  "DBVersion": "8.0",
  "RequestId": "67F2E75F-AE67-4FB2-821F-A81237EACD15",
  "GDNId": "gdn-bp1fttxsrmv*****",
  "CreateTime": "2020-02-24T11:57:54Z",
  "DBType": "MySQL",
  "GDNDescription": "GDN-fortest",
  "GlobalDomainName": "[gdnid].gdn.rds.aliyuncs.com",
  "DBClusters": [
    {
      "ReplicaLag": "1",
      "ExpireTime": "2020-11-14T16:00:00Z",
      "Expired": "false",
      "DBNodeClass": "polar.mysql.x4.large",
      "PayType": "Prepaid",
      "DBType": "MySQL",
      "RegionId": "cn-hangzhou",
      "DBVersion": "8.0",
      "DBClusterId": "pc-wz9fb5nn44u1d****",
      "DBClusterStatus": "Running",
      "StorageUsed": "3012558848",
      "DBClusterDescription": "test",
      "Category": "Normal",
      "Role": "primary",
      "ServerlessType": "AgileServerless",
      "DBNodes": [
        {
          "DBNodeClass": "polar.mysql.x4.large",
          "ZoneId": "cn-hangzhou-i",
          "CreationTime": "2020-03-23T21:35:43Z",
          "DBNodeRole": "Reader",
          "DBNodeStatus": "Running",
          "FailoverPriority": 1,
          "MaxConnections": 8000,
          "MaxIOPS": 32000,
          "DBNodeId": "pi-****************"
        }
      ]
    }
  ],
  "DBClusterId": "pc-bp1s826a1up******",
  "ResourceGroupId": "rg-************",
  "Labels": {
    "GDNVersion": ""
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	GDN.NotFound	Failed to found GdnInstance by name:%s
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.