Kueri detail Global Database Network - PolarDB - Alibaba Cloud - PolarDB

Mengambil detail untuk 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 dari Global Database Network (GDN).	gdn-bp1fttxsrmv*****
ResourceGroupId	string	No	ID grup sumber daya.	rg-************

Elemen respons

Element	Type	Description	Example
	object
GDNStatus	string	Status dari Global Database Network (GDN). Nilai yang valid: creating: GDN sedang dibuat. active: GDN sedang berjalan. deleting: GDN sedang dihapus. locked: GDN dikunci. Dalam status ini, Anda tidak dapat melakukan operasi apa pun pada cluster mana pun di GDN. removing_member: Sebuah cluster sedang dihapus dari GDN.	active
Connections	array<object>	Detail 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. Harus memenuhi persyaratan berikut: Tidak boleh dimulai dengan `http://` atau `https://`. Harus dimulai dengan huruf atau karakter Tionghoa. Hanya boleh berisi huruf, karakter Tionghoa, digit, 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>	Cluster-cluster di GDN.
	array<object>
ReplicaLag	string	Replication lag untuk replikasi lintas-region antara cluster primer dan cluster standby. Satuan: detik.	1
ExpireTime	string	Waktu kedaluwarsa cluster. Catatan Parameter ini hanya dikembalikan untuk cluster langganan (subscription). String kosong dikembalikan untuk cluster pay-as-you-go.	2020-11-14T16:00:00Z
Expired	string	Menunjukkan apakah cluster telah kedaluwarsa. Nilai yang valid: true: Cluster telah kedaluwarsa. false: Cluster belum kedaluwarsa. Catatan Parameter ini hanya dikembalikan untuk cluster langganan.	false
DBNodeClass	string	Jenis node.	polar.mysql.x4.large
PayType	string	Metode penagihan cluster. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: langganan.	Prepaid
DBType	string	Mesin database. Hanya MySQL yang didukung.	MySQL
RegionId	string	ID region cluster.	cn-hangzhou
DBVersion	string	Versi mesin database. Hanya versi 8.0 yang didukung.	8.0
DBClusterId	string	ID cluster.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	Status cluster. Untuk informasi lebih lanjut, lihat Status cluster.	Running
StorageUsed	string	Jumlah ruang penyimpanan yang digunakan. Satuan: byte.	3012558848
DBClusterDescription	string	Deskripsi cluster.	test
Category	string	Edisi cluster. Nilai yang valid: `Normal`: Cluster Edition `Basic`: Single-node Edition `Archive`: X-Engine Edition `NormalMultimaster`: Multi-master Cluster Edition `SENormal`: Standard Edition Catatan Single-node Edition tidak didukung untuk cluster PolarDB for PostgreSQL yang menjalankan PostgreSQL 11. Standard Edition didukung untuk cluster PolarDB for MySQL yang menjalankan MySQL 8.0 atau 5.7 dan untuk cluster PolarDB for PostgreSQL yang menjalankan PostgreSQL 14. X-Engine Edition dan Multi-master Cluster Edition hanya didukung untuk cluster PolarDB for MySQL yang menjalankan MySQL 8.0.	Normal
Role	string	Peran cluster di GDN. Nilai yang valid: primary: cluster primer standby: cluster standby Catatan Sebuah GDN terdiri dari satu cluster primer dan hingga empat cluster standby.	primary
ServerlessType	string	Jenis cluster Serverless. Nilainya tetap sebagai `AgileServerless`. Catatan Parameter ini hanya dikembalikan untuk cluster Serverless.	AgileServerless
DBNodes	array<object>	Detail node-node di cluster.
	object
DBNodeClass	string	The specifications of the node.	polar.mysql.x4.large
ZoneId	string	The zone ID of the node.	cn-hangzhou-i
CreationTime	string	The time when the node was created.	2020-03-23T21:35:43Z
DBNodeRole	string	The role of the node. Valid values: Writer: the primary node Reader: a read-only node	Reader
DBNodeStatus	string	The status of the node. Valid values: Creating: The node is being created. Running: The node is running. Deleting: The node is being deleted. Rebooting: The node is restarting. 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. MinorVersionUpgrading: The minor version of the node is being updated. Maintaining: The node is being maintained. Switching: A failover is being performed.	Running
FailoverPriority	integer	The failover priority. Each node is assigned a failover priority. The failover priority determines which node is selected as the primary node when a failover occurs. A larger value indicates a higher priority. Valid values: 1 to 15.	1
MaxConnections	integer	The maximum number of concurrent connections.	8000
MaxIOPS	integer	The maximum input/output operations per second (IOPS).	32000
DBNodeId	string	The node ID.	pi-****************
DBClusterId	string	ID cluster.	pc-bp1s826a1up******
ResourceGroupId	string	ID grup sumber daya.	rg-************
Labels	object	Label-label GDN.
GDNVersion	string	Versi GDN.	2.0

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": "2.0"
  }
}

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.