DescribeDBClusters - - Centre de documentation Alibaba Cloud

Consulte les détails des clusters PolarDB ou des clusters autorisés par l'autorisation RAM.

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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Remarque Vous pouvez appeler l'opération DescribeRegions pour interroger les régions disponibles.	cn-hangzhou
DBClusterIds	string	Non	L'identifiant du cluster. Séparez plusieurs identifiants de cluster par des virgules (,).	pc-****************
DBClusterDescription	string	Non	La description du cluster. La correspondance approximative est prise en charge.	pc-****************
ConnectionString	string	Non	Le point de terminaison de la base de données.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	Non	L'état du cluster. Pour les valeurs valides, consultez Tableau des états de cluster.	Running
DBType	string	Non	Le type de base de données. Valeurs valides :	MySQL
DescribeType	string	Non	Le mode de requête pour la liste. Définissez la valeur sur Simple pour utiliser le mode simple, qui renvoie uniquement les métadonnées de base des clusters.\n> Si vous ne spécifiez pas ce paramètre, le mode détaillé est utilisé par défaut, lequel renvoie des informations détaillées sur les clusters.	Simple
DBVersion	string	Non	La version du moteur de base de données.	5.6
RecentCreationInterval	integer	Non	Filtre les clusters créés au cours des N derniers jours. Valeurs valides : 0 à 15.	7
RecentExpirationInterval	integer	Non	Filtre les clusters qui expirent dans les N prochains jours. Valeurs valides : 0 à 15.	6
Expired	boolean	Non	Indique si le cluster a expiré. Valeurs valides : true false	true
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 30, 50 et 100. Valeur par défaut : 30.	30
PageNumber	integer	Non	Le numéro de page. La valeur doit être un entier positif ne dépassant pas la valeur maximale du type de données Integer. Valeur par défaut : 1.	10
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-**********
Tag	array<object>	Non	Les balises.
	object	Non
Key	string	Non	La clé de la balise. Vous pouvez utiliser les balises pour filtrer la liste des clusters. Vous pouvez spécifier jusqu'à 20 paires de balises. Le numéro n de chaque paire de balises doit être unique et doit être un entier consécutif commençant à 1. Le paramètre Tag.n.Key est associé au paramètre Tag.n.Value. Remarque La clé de la balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par `aliyun`, `acs:`, `http://` ou `https://`.	MySQL
Value	string	Non	La valeur de balise qui correspond à la clé de balise. Remarque La valeur de balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par `aliyun`, `acs:`, `http://` ou `https://`.	5.6
PayType	string	Non	La méthode de facturation. Valeurs valides : Postpaid : postpayé. Prepaid : abonnement.	Postpaid
DBNodeIds	string	Non	L'identifiant du nœud. Vous pouvez spécifier plusieurs identifiants de nœud, séparés par des virgules (,).	pi-***************

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalRecordCount	integer	Le nombre total d'enregistrements.	16
PageRecordCount	integer	Le nombre de clusters sur la page actuelle.	5
RequestId	string	L'identifiant de la requête.	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	Le numéro de page.	12
Items	object
DBCluster	array<object>	La liste des clusters.
	array<object>
VpcId	string	The VPC ID.	vpc-****************
VswitchId	string	The vSwitch ID.	vsw-***************
ExpireTime	string	The expiration time of the cluster. Remarque This parameter is returned only for Prepaid (subscription) clusters. An empty value is returned for Postpaid (pay-as-you-go) clusters.	2020-11-14T16:00:00Z
Expired	string	Indicates whether the cluster has expired. Valid values: true false Remarque This parameter is returned only for Prepaid (subscription) clusters.	false
DBNodeNumber	integer	The number of nodes.	2
CreateTime	string	The creation time.	2020-08-14T05:58:42Z
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
StoragePayType	string	The storage billing method. Valid values: Postpaid: pay-by-capacity (pay-as-you-go billing method). Prepaid: pay-by-space (subscription).	Prepaid
ServerlessType	string	The serverless type. A return value of AgileServerless indicates that the cluster is a serverless cluster. An empty value indicates that the cluster is a common cluster.	AgileServerless
StrictConsistency	string	Indicates whether multi-zone data strong consistency is enabled for the cluster. Valid values: ON: Multi-zone data strong consistency is enabled. This applies to Standard Edition 3AZ scenarios. OFF: Multi-zone data strong consistency is not enabled.	ON
DBNodeClass	string	The node specifications.	polar.mysql.x4.large
Tags	object
Tag	array<object>	The tags.
	object
Key	string	The tag key.	MySQL
Value	string	The tag value.	5.6
DBType	string	The database type.	MySQL
LockMode	string	The lock status of the cluster. Valid values: Unlock: Normal. ManualLock: Manually locked. LockByExpiration: Automatically locked due to cluster expiration.	Unlock
DBNodes	object
DBNode	array<object>	The node list.
	object
DBNodeClass	string	The node specifications.	polar.mysql.x4.large
ZoneId	string	The zone ID.	cn-hangzhou-i
DBNodeRole	string	The node role. Valid values: Writer: primary node. Reader: read-only node. ColumnReader: column store read-only node. AI: AI node.	Reader
DBNodeId	string	The node ID.	pi-****************
RegionId	string	The region ID.	cn-hangzhou
Serverless	string	Indicates whether the serverless feature is enabled for the node. A return value of ON indicates that the serverless feature is enabled. An empty value indicates that the serverless feature is not enabled.	ON
ImciSwitch	string	Indicates whether In-Memory Column Index (IMCI) is enabled. Valid values: ON: enabled. OFF: disabled.	OFF
HotReplicaMode	string	Indicates whether hot standby is enabled. Valid values: ON: enabled. OFF: disabled.	OFF
RegionId	string	The region ID.	cn-hangzhou
DeletionLock	integer	The deletion protection status of the cluster. Valid values: 0: not locked. 1: locked. Remarque When the cluster is locked, it cannot be deleted.	0
DBVersion	string	The database engine version.	5.6
DBClusterId	string	The cluster ID.	pc-****************
DBClusterStatus	string	The cluster status.	Running
ResourceGroupId	string	The resource group ID.	rg-************
SearchStorageUsed	integer	The storage usage of the Search node.	89227945573
StorageSpace	integer	The storage space for pay-by-space (subscription) billing. Unit: bytes.	50
DBClusterNetworkType	string	The network type of the cluster.	VPC
DBClusterDescription	string	The cluster description.	GDN-1
ZoneId	string	The zone ID.	cn-hangzhou-i
Engine	string	The cluster engine.	POLARDB
Category	string	The cluster edition. Valid values: Normal: Cluster Edition. Basic: Single Node Edition. Archive: X-Engine Edition. NormalMultimaster: Multi-master Cluster (Database/Table).	Normal
AiType	string	The AI node information status. Valid values: SearchNode: search node. DLNode: AI node. Valeurs valides : SearchNode\|DLNode : Both DLNode : DLNode SearchNode : SearchNode	SearchNode
CpuCores	string	The number of CPU cores.	1
MemorySize	string	The memory size of the node. Unit: MB.	2048
StorageType	string	The storage type for Enterprise Edition. Valid values: HighPerformance: PSL5. Standard: PSL4. The storage type for Standard Edition. Valid values: essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	The hot standby storage cluster status. Valid values: ON: enabled. OFF: disabled.	OFF
SubCategory	string	The specification type of the compute node. Valid values: Exclusive: Dedicated. General: General-purpose.	Exclusive
StorageUsed	integer	The storage usage of the cluster. Unit: bytes.	3009413120
RemoteMemorySize	string	The remote memory size. Unit: MB.	3612
ConnectionResourceQuota	integer
ConnectionResourceUsed	integer

Exemples

JSON format

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": {
    "DBCluster": [
      {
        "VpcId": "vpc-****************",
        "VswitchId": "vsw-***************",
        "ExpireTime": "2020-11-14T16:00:00Z",
        "Expired": "false",
        "DBNodeNumber": 2,
        "CreateTime": "2020-08-14T05:58:42Z",
        "PayType": "Prepaid",
        "StoragePayType": "Prepaid",
        "ServerlessType": "AgileServerless",
        "StrictConsistency": "ON",
        "DBNodeClass": "polar.mysql.x4.large",
        "Tags": {
          "Tag": [
            {
              "Key": "MySQL",
              "Value": "5.6"
            }
          ]
        },
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "DBNodes": {
          "DBNode": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "ZoneId": "cn-hangzhou-i",
              "DBNodeRole": "Reader",
              "DBNodeId": "pi-****************",
              "RegionId": "cn-hangzhou",
              "Serverless": "ON",
              "ImciSwitch": "OFF",
              "HotReplicaMode": "OFF"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "5.6",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-************",
        "SearchStorageUsed": 89227945573,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode",
        "CpuCores": "1",
        "MemorySize": "2048",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF",
        "SubCategory": "Exclusive",
        "StorageUsed": 3009413120,
        "RemoteMemorySize": "3612",
        "ConnectionResourceQuota": 0,
        "ConnectionResourceUsed": 0
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	NumberExceed.Tags	The Tags parameter's number is exceed.	The number of tags specified in the tags parameter exceeds the limit.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
400	InvalidRecentCreationInterval.Malformed	The specified parameter RecentCreationInterval is not valid.	The specified RecentCreationInterval parameter is invalid.
400	InvalidRecentExpirationInterval.Malformed	The specified parameter RecentExpirationInterval is not valid.	The specified RecentExpirationInterval parameter is invalid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	The request failed to be processed because unknown errors, exceptions, or failures have occurred.
404	DBTypeOrDBVersion.Malformed	The specified DBType does not match DBVersion.	The specified values of DBType and DBVersion do not match.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A temporary server error occurred.

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

Notes de version

Consultez Notes de version pour la liste complète.