DescribeGlobalDatabaseNetwork - PolarDB - Centre de documentation Alibaba Cloud

Consulte les détails d'un réseau de bases de données global (GDN).

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

polardb:DescribeGlobalDatabaseNetwork

get

*dbcluster.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GDNId	string	Oui	L'identifiant du GDN.	gdn-bp1fttxsrmv*****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-************

Éléments de réponse

Élément	Type	Description	Exemple
	object
GDNStatus	string	L'état du GDN. Valeurs valides : creating : En cours de création. active : En cours d'exécution. deleting : En cours de suppression. locked : Verrouillé. Aucune opération ne peut être effectuée sur les clusters du GDN. removing_member : Un cluster est en cours de retrait du GDN.	active
Connections	array<object>	Les informations de connexion.
	object
ConnectionString	string	La chaîne de connexion.	abc.polardb.rds.aliyuncs.com
NetType	string	Le type de réseau.	Private
Port	string	Le numéro de port de la chaîne de connexion.	3306
DBVersion	string	La version du moteur de base de données. Actuellement, seule la version 8.0 est prise en charge.	8.0
RequestId	string	L'identifiant de la requête.	67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNId	string	L'identifiant du GDN.	gdn-bp1fttxsrmv*****
CreateTime	string	L'heure de création du GDN. L'heure est au format ISO 8601 en temps universel coordonné (UTC) (format : YYYY-MM-DDTHH:mm:ssZ).	2020-02-24T11:57:54Z
DBType	string	Le type de moteur de base de données. Actuellement, seul MySQL est pris en charge.	MySQL
GDNDescription	string	La description du GDN. La description doit respecter les exigences suivantes : Elle ne peut pas commencer par http:// ou https://. Elle doit commencer par une lettre majuscule, une lettre minuscule ou un caractère chinois. Elle peut contenir des lettres majuscules, des lettres minuscules, des caractères chinois, des chiffres, des traits de soulignement (_) ou des traits d'union (-). Sa longueur doit être comprise entre 2 et 126 caractères.	GDN-fortest
GlobalDomainName	string	Le nom de domaine global.	[gdnid].gdn.rds.aliyuncs.com
DBClusters	array<object>	Les clusters du GDN.
	array<object>
ReplicaLag	string	Le délai de réplication interrégionale entre les clusters principal et secondaire. Unité : secondes.	1
ExpireTime	string	L'heure d'expiration du cluster. Remarque Ce paramètre n'est renvoyé que pour les clusters dont le mode de facturation est Prepaid (abonnement). Une valeur vide est renvoyée pour les clusters Postpaid (postpayé). L'heure est au format ISO 8601 en temps universel coordonné (UTC) (format : YYYY-MM-DDTHH:mm:ssZ).	2020-11-14T16:00:00Z
Expired	string	Indique si le cluster a expiré. Valeurs valides : true false Remarque Ce paramètre n'est renvoyé que pour les clusters dont le mode de facturation est Prepaid (abonnement).	false
DBNodeClass	string	Les spécifications du nœud de base de données.	polar.mysql.x4.large
PayType	string	Le mode de facturation. Valeurs valides : Postpaid : postpayé. Prepaid : abonnement.	Prepaid
DBType	string	Le type de moteur de base de données. Actuellement, seul MySQL est pris en charge.	MySQL
RegionId	string	L'identifiant de la région.	cn-hangzhou
DBVersion	string	La version du moteur de base de données. Actuellement, seule la version 8.0 est prise en charge.	8.0
DBClusterId	string	L'identifiant du cluster dans le GDN.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	L'état du cluster dans le GDN. Pour plus d'informations, consultez Tableau des états de cluster.	Running
StorageUsed	string	L'utilisation du stockage. Unité : octets.	3012558848
DBClusterDescription	string	La description du cluster.	test
Category	string	L'édition du produit. Valeurs valides : Normal : Édition Cluster Basic : Édition Nœud unique Archive : Édition PolarDB X-Engine NormalMultimaster : Édition Cluster multi-maître SENormal : Édition standard PolarDB for MySQL Remarque PolarDB for PostgreSQL 11 ne prend pas en charge l'édition Nœud unique. PolarDB for MySQL 8.0, PolarDB for MySQL 5.7 et PolarDB for PostgreSQL 14 prennent en charge l'édition standard PolarDB for MySQL. PolarDB for MySQL 8.0 prend en charge l'édition PolarDB X-Engine et l'édition Cluster multi-maître.	Normal
Role	string	Le rôle du cluster. Valeurs valides : primary : cluster principal standby : cluster secondaire Remarque Un GDN contient un cluster principal et jusqu'à quatre clusters secondaires.	primary
ServerlessType	string	Le type serverless. La valeur est fixée à AgileServerless. Remarque Ce paramètre n'est pris en charge que pour les clusters serverless.	AgileServerless
DBNodes	array<object>	Les détails des nœuds de base de données.
	object
DBNodeClass	string	Les spécifications du nœud de base de données.	polar.mysql.x4.large
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-i
CreationTime	string	L'heure de création du nœud de base de données. L'heure est au format ISO 8601 en temps universel coordonné (UTC) (format : YYYY-MM-DDTHH:mm:ssZ).	2020-03-23T21:35:43Z
DBNodeRole	string	Le rôle du nœud de base de données. Valeurs valides : Writer : nœud principal Reader : nœud en lecture seule	Reader
DBNodeStatus	string	L'état du nœud. Valeurs valides : Creating : En cours de création. Running : En cours d'exécution. Deleting : En cours de suppression. Rebooting : En cours de redémarrage. ClassChanging : Les spécifications du nœud sont en cours de modification. NetAddressCreating : La connectivité réseau est en cours de création. NetAddressDeleting : La connectivité réseau est en cours de suppression. NetAddressModifying : La connectivité réseau est en cours de modification. MinorVersionUpgrading : Une mise à niveau de version mineure du moteur est en cours. Maintaining : Le cluster est en cours de maintenance. Switching : Un basculement est en cours.	Running
FailoverPriority	integer	La priorité de basculement. Chaque nœud possède une priorité de basculement qui détermine la probabilité que le nœud soit élu comme nœud principal lors d'un basculement. Une valeur plus élevée indique une priorité plus haute. Valeurs valides : 1 à 15.	1
MaxConnections	integer	Le nombre maximal de connexions simultanées au cluster.	8000
MaxIOPS	integer	Le nombre maximal de requêtes d'E/S par seconde (IOPS).	32000
DBNodeId	string	L'identifiant du nœud de base de données.	pi-****************
DBClusterId	string	L'identifiant du cluster.	pc-bp1s826a1up******
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-************
Labels	object	Les étiquettes de propriété.
GDNVersion	string	La version du GDN.	2.0

Exemples

JSON format

{
  "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"
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	GDN.NotFound	Failed to found GdnInstance by name:%s
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	L'opération a échoué. L'identifiant de l'instance de cluster spécifié n'existe pas.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.