DescribeDBClusterAttribute - - Centre de documentation Alibaba Cloud

Consulte les informations sur les attributs d'un cluster.

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

get

*DBCluster.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBClusterId	string	Oui	L'identifiant du cluster. Remarque Vous pouvez appeler l'opération DescribeDBClusters pour consulter les détails de tous les clusters de votre compte, y compris l'identifiant du cluster.	pc-*****************
DescribeType	string	Non	Indique si les informations sur les nœuds liés à l'IA doivent être récupérées.	AI

Éléments de réponse

Élément	Type	Description	Exemple
	object
DeletionLock	integer	L'état de verrouillage de la suppression du cluster. Valeurs valides : 0 : Déverrouillé. Le cluster peut être supprimé. 1 : Verrouillé. Le cluster ne peut pas être supprimé.	0
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 de 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 de PolarDB for MySQL. PolarDB for MySQL 8.0 prend en charge l'édition PolarDB X-Engine et l'édition Cluster multi-maître.	Normal
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-***************
DataLevel1BackupChainSize	integer	La taille totale des sauvegardes de niveau 1 (instantanés). Unité : octets.	74448896
DBClusterId	string	L'identifiant du cluster.	pc-*****************
DBType	string	Le type de moteur de base de données.	MySQL
DBClusterNetworkType	string	Le type de réseau du cluster.	VPC
IsLatestVersion	boolean	Indique si le cluster exécute la dernière version du noyau. Valeurs valides :	false
HasCompleteStandbyRes	boolean	Indique si les ressources de la nouvelle base de données principale sont réapprovisionnées après un basculement interzones. Valeurs valides : true : Les ressources sont réapprovisionnées. false : Les ressources ne sont pas réapprovisionnées.	false
HotStandbyCluster	string	Indique si le cluster de stockage de secours à chaud (et les nœuds de calcul de secours) est activé. Valeurs valides : StandbyClusterON : Le cluster de stockage de secours à chaud et les nœuds de calcul de secours sont activés. StandbyClusterOFF : Le cluster de stockage de secours à chaud et les nœuds de calcul de secours sont désactivés.	StandbyClusterON
DataSyncMode	string	Le mode de réplication des données. Valeurs valides : AsyncSync : asynchrone SemiSync : semi-synchrone	AsyncSync
StandbyHAMode	string	Le mode de reprise après sinistre interzones. Valeurs valides : ON : le mode de reprise après sinistre interzones est activé. OFF : le mode de reprise après sinistre interzones est désactivé. 0 : mode de test client.	OFF
CompressStorageMode	string	Indique si la compression du stockage est activée. Valeurs valides :	ON
StorageMax	integer	La capacité de stockage maximale pour les spécifications actuelles du cluster. Unité : octets.	10995116277760
DBVersion	string	La version du moteur de base de données.	8.0
DBNodes	array<object>	Les informations sur les nœuds.
	object
CreationTime	string	L'heure de création du nœud.	2020-03-23T21:35:43Z
FailoverPriority	integer	La priorité de basculement. Chaque nœud dispose d'une priorité de basculement qui détermine la probabilité qu'il soit élu nœud principal lors d'un basculement. Une valeur plus élevée indique une priorité plus élevée. Valeurs valides : 1 à 15.	1
MaxIOPS	integer	Le nombre maximal de requêtes d'E/S par seconde (IOPS).	32000
DBNodeClass	string	Les spécifications du nœud.	polar.mysql.x4.large
CpuCores	string	Le nombre de cœurs de processeur du nœud.	2
MemorySize	string	La taille de la mémoire du nœud. Unité : Mo.	8192
DBNodeRole	string	Le rôle du nœud. Valeurs valides :	Reader
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-i
MaxConnections	integer	Le nombre maximal de connexions simultanées au cluster.	8000
DBNodeStatus	string	L'état du nœud. Valeurs valides :	Running
DBNodeId	string	L'identifiant du nœud.	pi-****************
ImciSwitch	string	Indique si l'index de colonnes en mémoire est activé. Valeurs valides :	ON
HotReplicaMode	string	Indique si le secours à chaud est activé. Valeurs valides :	ON
AddedCpuCores	string	Le nombre de cœurs de processeur ajoutés par la mise à l'échelle automatique des ressources locales.	6
MasterId	string	L'identifiant du nœud principal de l'édition Multi-master Cluster.	pi-bp18z52akld3*****
SccMode	string	Indique si la fonctionnalité de cohérence globale (mode haute performance) est activée pour le nœud. Valeurs valides :	ON
ServerWeight	string	Le poids de routage.	1
ServerlessType	string	Le type serverless du nœud. Valeurs valides : AgileServerless : serverless agile. Le nœud est un nœud serverless. SteadyServerless : serverless stable. Le nœud est un nœud à spécifications définies pour lequel la fonctionnalité serverless est activée. Remarque Ce paramètre est pris en charge uniquement pour les clusters serverless ou les clusters à spécifications définies pour lesquels la fonctionnalité serverless est activée. Pour plus d'informations, consultez Serverless.	SteadyServerless
SubCluster	string	Indique si le nœud se trouve dans la zone principale ou la zone secondaire. Ce paramètre est principalement utilisé pour les déploiements symétriques en ressources. Valeurs valides : Primary : zone principale. Standby : zone secondaire.	Primary
RemoteMemorySize	string	La taille de la mémoire distante. Unité : Mo.	3072
Orca	string	La fonctionnalité Orca. Valeurs valides :	off
MultiMasterLocalStandby	string	Le nœud de secours local multi-maître.	pi-****************
MultiMasterPrimaryNode	string	Le nœud principal multi-maître.	pi-****************
DBNodeDescription	string	La description du nœud.	test
SubGroupDescription	string	La description du sous-groupe de cluster.	description de test
MirrorInsName	string	Le nom de la réplique à chaud correspondant au nœud dans l'architecture de stockage et de calcul de secours à chaud.	pi-bp18z52mirror*****
DBNodeCXLRemoteMemory	string	La configuration de la mémoire distante CXL.	3072
RemoteMemoryMin	integer
RemoteMemoryMax	integer
RemoteMemoryRecommended	integer
DedicatedHostModel	boolean
ZoneIds	string	L'identifiant de la zone.	cn-hangzhou-i,cn-hangzhou-g
MaintainTime	string	La fenêtre de maintenance du cluster. L'heure est au format `HH:mmZ-HH:mmZ` (UTC). Par exemple, `16:00Z-17:00Z` indique que la maintenance de routine peut être effectuée de 00:00 à 01:00 (UTC+08:00).	18:00Z-19:00Z
Engine	string	Le moteur du cluster.	POLARDB
Tags	array<object>	Les informations sur les balises.
	object
Key	string	La clé de la balise.	test
Value	string	La valeur de la balise.	MySQL
RequestId	string	L'identifiant de la requête.	074467EF-86B9-4C23-ACBF-E9B81A******
VPCId	string	L'identifiant du VPC.	vpc-*******************
SearchClusterStatus	string	L'état de fonctionnement du nœud de recherche.	Running
VSwitchId	string	L'identifiant du vSwitch.	vsw-*********************
DBClusterDescription	string	La description du cluster.	test
Expired	string	Indique si le cluster a expiré.	false
PayType	string	La méthode de facturation. Valeurs valides :	Prepaid
StoragePayType	string	Le mode de facturation du stockage. Valeurs valides : Postpaid : paiement à l'usage. Prepaid : abonnement.	Prepaid
LockMode	string	Le mode de verrouillage. Valeurs valides :	Unlock
SearchStorageUsed	integer	L'utilisation du stockage du nœud de recherche.	3012558848
SearchCompressStorageUsed	integer	La taille des données de stockage compressées du nœud de recherche.	15529410560
StorageSpace	integer	L'espace de stockage facturé selon l'espace (abonnement). Unité : octets.	50
DBVersionStatus	string	L'état de la version mineure actuelle. Valeurs valides : Stable : La version actuelle est stable. Old : La version actuelle est obsolète. Effectuez une mise à niveau vers la dernière version. HighRisk : La version actuelle présente des défauts critiques. Effectuez immédiatement une mise à niveau vers la dernière version. Beta : La version actuelle est une version bêta. Remarque Pour plus d'informations sur la mise à niveau de la version mineure, consultez Mise à niveau de la version. Ce paramètre est renvoyé uniquement lorsque le type de moteur de base de données (DBType) est MySQL.	Stable
CreationTime	string	L'heure de création du cluster.	2020-08-14T05:58:42Z
SQLSize	integer	La taille de stockage des instructions SQL. Unité : octets. Une valeur de -1 indique qu'aucune donnée n'est disponible.	0
InodeTotal	integer	Le nombre maximal d'inodes dans le système de fichiers.	6,291,456
InodeUsed	integer	L'utilisation actuelle des inodes.	4,194,304
BlktagTotal	integer	Le nombre maximal de blktags dans le système de fichiers.	7,864,320
BlktagUsed	integer	L'utilisation actuelle des blktags.	5,242,880
RegionId	string	L'identifiant de la région.	cn-hangzhou
ExpireTime	string	La date d'expiration du cluster. Remarque Seuls les clusters dont le mode de facturation est Prepaid (abonnement) renvoient une valeur spécifique pour ce paramètre. Les clusters Postpaid (à la demande) renvoient une valeur vide.	2020-11-14T16:00:00Z
SubCategory	string	Le type de spécification du nœud de calcul. Valeurs valides : Exclusive : Dédié General : Usage général Remarque Ce paramètre est renvoyé uniquement pour les clusters PolarDB for MySQL Cluster Edition.	Exclusive
IsProxyLatestVersion	boolean	Indique si le proxy de base de données est de la dernière version. Valeurs valides :	false
StorageType	string	Le type de stockage. La valeur est fixée à HighPerformance.	HighPerformance
ServerlessType	string	Le type serverless du cluster. Valeurs valides : AgileServerless : serverless agile. Cette valeur indique un cluster serverless. SteadyServerless : serverless stable. Cette valeur indique un cluster à spécifications définies pour lequel la fonctionnalité serverless est activée. Remarque Ce paramètre est pris en charge uniquement pour les clusters serverless ou les clusters à spécifications définies pour lesquels la fonctionnalité serverless est activée.	SteadyServerless
StrictConsistency	string	Indique si la cohérence forte des données multizone est activée pour le cluster. Valeurs valides :	ON
ProxyCpuCores	string	Le nombre de cœurs de processeur du proxy de base de données.	4
ProxyStandardCpuCores	string	Le nombre de cœurs de processeur dans la configuration standard du proxy de base de données.	2
ProxyType	string	Le type de proxy de base de données. Valeurs valides :	Exclusive
ProxyStatus	string	L'état du proxy de base de données. Valeurs valides :	Running
ProxyServerlessType	string	Le type serverless du proxy de base de données. Valeurs valides : AgileServerless : serverless agile, qui indique un cluster serverless. SteadyServerless : serverless stable, qui indique un cluster avec des spécifications définies (un cluster par abonnement ou à la demande).	SteadyServerless
Architecture	string	L'architecture du processeur. Valeurs valides :	X86
AiType	string	Le type de nœud d'IA. Valeurs valides :	DLNode
ProvisionedIops	string		2500
AiCreatingTime	string	L'heure de début de la fonctionnalité IA gratuite.	2024-03-13T01:20:28Z
SupportInstantSwitchWithImci	string	Indique si la fonctionnalité de basculement avec réplica chaud compatible avec IMCI est prise en charge.	ON
Orca	string	La fonctionnalité Orca. Valeurs valides :	ON
SourceDBCluster	string	L'identifiant du cluster source. Remarque Ce paramètre est pris en charge uniquement pour les clusters restaurés à partir d'un jeu de sauvegarde ou d'un point dans le temps après le 1er juin 2024.	pc-pz51ziv48317b2880
RestoreType	string	La méthode de restauration du cluster. Valeurs valides : RestoreByTime : restaure à partir d'un point dans le temps basé sur une sauvegarde de niveau 1. RestoreByBackupSet : restaure à partir d'un jeu de sauvegarde basé sur une sauvegarde de niveau 1. RestoreByTimeOss : restaure à partir d'un point dans le temps basé sur une sauvegarde de niveau 2. RestoreByBackupSetOss : restaure à partir d'un jeu de sauvegarde basé sur une sauvegarde de niveau 2. CloneFromSourceCluster : clone à partir du cluster source. Remarque Ce paramètre est pris en charge uniquement pour les clusters qui sont restaurés à partir d'un jeu de sauvegarde ou d'un point dans le temps après le 1er juin 2024.	RestoreByTime
RestoreDataPoint	string	Si RestoreType est RestoreByTime ou RestoreByTimeOss, cette valeur indique le point dans le temps auquel le cluster est restauré. Si RestoreType est RestoreByBackupSet ou RestoreByBackupSetOss, cette valeur indique l'identifiant du jeu de sauvegarde à partir duquel le cluster est restauré. Remarque Ce paramètre est pris en charge uniquement pour les clusters restaurés à partir d'un jeu de sauvegarde ou à un point dans le temps postérieur au 1er juin 2024.	2179639137
SourceRegionId	string	L'identifiant de la région du cluster source.	cn-beijing
ImciAutoIndex	string	La fonctionnalité d'accélération automatique des requêtes basée sur IMCI. Valeurs valides :	OFF
AutoUpgradeMinorVersion	string	La stratégie de mise à jour des versions mineures.	Manual
BurstingEnabled	string	Indique si le burst de performances d'E/S est activé pour le disque cloud ESSD AutoPL. Valeurs valides :	false
RowCompression	string	Le paramètre de compression des lignes.	OFF
ImperceptibleSwitch	string	La fonctionnalité de basculement avec réplica chaud. Valeurs valides :	true
StorageUsed	integer	L'utilisation du stockage. Unité : octets.	3012558848
CompressStorageUsed	integer	La taille des données de stockage après compression.	15529410560
DBClusterStatus	string	L'état du cluster. Pour plus d'informations, consultez Tableau des états de cluster.	Running
Branch	object
ParentInsName	string
BranchTime	string
BranchLsn	string
ChildBranch	array<object>
	object
InsName	string
DBClusterDescription	string
BranchTime	string
BranchLsn	string
HasChild	boolean
ColumnTable	string	Indique si la table de stockage en colonnes est activée.	OFF
ConnectionResourceQuota	integer	Le quota de ressources de connexion (exclusivité AgenticDB).
ConnectionResourceUsed	integer	Le nombre de ressources de connexion utilisées (exclusivité AgenticDB).
StorageUpperBound	integer
StorageAutoScale	string

Exemples

JSON format

{
  "DeletionLock": 0,
  "Category": "Normal",
  "ResourceGroupId": "rg-***************",
  "DataLevel1BackupChainSize": 74448896,
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL",
  "DBClusterNetworkType": "VPC",
  "IsLatestVersion": false,
  "HasCompleteStandbyRes": false,
  "HotStandbyCluster": "StandbyClusterON",
  "DataSyncMode": "AsyncSync",
  "StandbyHAMode": "OFF",
  "CompressStorageMode": "ON",
  "StorageMax": 10995116277760,
  "DBVersion": "8.0",
  "DBNodes": [
    {
      "CreationTime": "2020-03-23T21:35:43Z",
      "FailoverPriority": 1,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "CpuCores": "2",
      "MemorySize": "8192",
      "DBNodeRole": "Reader",
      "ZoneId": "cn-hangzhou-i",
      "MaxConnections": 8000,
      "DBNodeStatus": "Running",
      "DBNodeId": "pi-****************",
      "ImciSwitch": "ON",
      "HotReplicaMode": "ON",
      "AddedCpuCores": "6",
      "MasterId": "pi-bp18z52akld3*****",
      "SccMode": "ON",
      "ServerWeight": "1",
      "ServerlessType": "SteadyServerless",
      "SubCluster": "Primary",
      "RemoteMemorySize": "3072",
      "Orca": "off",
      "MultiMasterLocalStandby": "pi-****************",
      "MultiMasterPrimaryNode": "pi-****************",
      "DBNodeDescription": "test",
      "SubGroupDescription": "test Description",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": "3072",
      "RemoteMemoryMin": 0,
      "RemoteMemoryMax": 0,
      "RemoteMemoryRecommended": 0,
      "DedicatedHostModel": false
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Key": "test",
      "Value": "MySQL"
    }
  ],
  "RequestId": "074467EF-86B9-4C23-ACBF-E9B81A******",
  "VPCId": "vpc-*******************",
  "SearchClusterStatus": "Running",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 3012558848,
  "SearchCompressStorageUsed": 15529410560,
  "StorageSpace": 50,
  "DBVersionStatus": "Stable",
  "CreationTime": "2020-08-14T05:58:42Z",
  "SQLSize": 0,
  "InodeTotal": 0,
  "InodeUsed": 0,
  "BlktagTotal": 0,
  "BlktagUsed": 0,
  "RegionId": "cn-hangzhou",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "SubCategory": "Exclusive",
  "IsProxyLatestVersion": false,
  "StorageType": "HighPerformance",
  "ServerlessType": "SteadyServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "SteadyServerless",
  "Architecture": "X86",
  "AiType": "DLNode",
  "ProvisionedIops": "2500",
  "AiCreatingTime": "2024-03-13T01:20:28Z",
  "SupportInstantSwitchWithImci": "ON",
  "Orca": "ON",
  "SourceDBCluster": "pc-pz51ziv48317b2880",
  "RestoreType": "RestoreByTime",
  "RestoreDataPoint": "2179639137",
  "SourceRegionId": "cn-beijing",
  "ImciAutoIndex": "OFF",
  "AutoUpgradeMinorVersion": "Manual",
  "BurstingEnabled": "false",
  "RowCompression": "OFF",
  "ImperceptibleSwitch": "true",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running",
  "Branch": {
    "ParentInsName": "",
    "BranchTime": "",
    "BranchLsn": "",
    "ChildBranch": [
      {
        "InsName": "",
        "DBClusterDescription": "",
        "BranchTime": "",
        "BranchLsn": "",
        "HasChild": false
      }
    ]
  },
  "ColumnTable": "OFF",
  "ConnectionResourceQuota": 0,
  "ConnectionResourceUsed": 0,
  "StorageUpperBound": 0,
  "StorageAutoScale": ""
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	L'identifiant DBClusterId spécifié n'existe pas dans les enregistrements actuels.

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

Notes de version

Consultez Notes de version pour la liste complète.