DescribeDBClusters - - Centre de documentation Alibaba Cloud

Consulte les clusters de l'Édition Data Warehouse.

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.

adb:DescribeDBClusters

get

DBCluster.

acs:adb:{#regionId}:{#accountId}:dbcluster/*

Aucune

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 obtenir les identifiants des régions disponibles.	cn-hangzhou
DBClusterIds	string	Non	Les identifiants des clusters. Remarque Vous pouvez saisir n'importe quel identifiant de cluster dans la région spécifiée.	am-bp1r053byu48p****
DBClusterDescription	string	Non	La description du cluster. Elle ne peut pas commencer par http:// ou https://. Elle doit comporter entre 2 et 256 caractères.	test
DBClusterStatus	string	Non	L'état du cluster. Valeurs valides : Preparing : en préparation Creating : en cours de création Restoring : restauration à partir d'une sauvegarde Running : en cours d'exécution Deleting : en cours de suppression ClassChanging : changement de spécifications NetAddressCreating : création d'une adresse réseau NetAddressDeleting : suppression d'une adresse réseau	Running
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 30 (par défaut) 50 100	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.	1
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-4690g37929XXXX
Tag	array<object>	Non	La liste des balises.
	object	Non	Les détails de la balise.
Key	string	Non	La clé de la balise. Vous pouvez filtrer la liste des clusters par balise. Vous pouvez spécifier jusqu'à 20 paires clé-valeur de balise. Le numéro N dans chaque paire clé-valeur de balise doit être unique et doit être un entier consécutif commençant par 1. La valeur de Tag.N.Key correspond à la valeur de 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://.	tag1
Value	string	Non	La valeur de la balise. Vous pouvez filtrer la liste des clusters par balise. Vous pouvez spécifier jusqu'à 20 paires clé-valeur de balise. Le numéro N dans chaque paire clé-valeur de balise doit être unique et doit être un entier consécutif commençant par 1. La valeur de Tag.N.Key correspond à la valeur de Tag.N.Value. Remarque La valeur de la balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par aliyun, acs:, http:// ou https://.	test1
DBVersion	string	Non	La version du cluster. Définissez la valeur sur 3.0.	3.0
DBClusterVersion	string	Non	L'édition du cluster. Valeurs valides : 3.0 : Édition Data Warehouse. 5.0 (par défaut) : Édition Data Lakehouse, Édition Entreprise et Édition de base. All : toutes les éditions, y compris l'Édition Data Warehouse, l'Édition Data Lakehouse, l'Édition Entreprise et l'Édition de base. Valeurs valides : All : toutes les éditions, y compris l'Édition Data Warehouse, l'Édition Data Lakehouse, l'Édition Entreprise et l'Édition de base. 3.0 : Édition Data Warehouse. 5.0 : Édition Data Lakehouse, Édition Entreprise et Édition de base.	3.0

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les détails de la liste.
TotalCount	integer	Le nombre total d'enregistrements.	1
PageSize	integer	Le nombre d'enregistrements par page.	30
RequestId	string	L'identifiant de la requête.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	Le numéro de page.	1
Items	object
DBCluster	array<object>	La liste des informations du cluster.
	array<object>	Les détails de la balise.
DtsJobId	string	L'identifiant de la tâche de synchronisation Data Transmission Service (DTS). Ce paramètre n'est renvoyé que pour les instances analytiques MySQL.	dtsb1578j90XXXX
DBNodeCount	integer	Le nombre de groupes de nœuds.	1
Expired	string	Indique si le cluster a expiré. Valeurs valides : true : le cluster a expiré. false : le cluster n'a pas expiré.	false
CreateTime	string	L'heure de création du cluster. L'heure est affichée en UTC au format yyyy-MM-ddTHH:mm:ssZ. Exemple : 2021-04-01T09:50:18Z.	2021-04-01T09:50:18Z
PayType	string	La méthode de facturation du cluster. Valeurs valides : Postpaid : paiement à l'usage. Prepaid : abonnement.	Postpaid
DiskType	string	Le type de disque du cluster. Valeurs valides : local_ssd : disque local. cloud : disque de base. cloud_ssd : SSD standard. cloud_efficiency : disque ultra. cloud_essd0 : ESSD PL0. cloud_essd : ESSD PL1. cloud_essd2 : ESSD PL2. cloud_essd3 : ESSD PL3. Remarque Pour plus d'informations sur les disques ESSD, consultez Spécifications des disques ESSD.	cloud_essd
Tags	object
Tag	array<object>	La liste des balises.
	object	Les détails de la balise.
Key	string	La clé de balise. Remarque Vous pouvez appeler l'opération TagResources pour créer des balises pour le cluster.	tag1
Value	string	La valeur de balise.	test1
Mode	string	Le mode du cluster. Valeurs valides : flexible : mode élastique. reserver : mode réservé. Remarque Pour plus d'informations sur les modes de cluster, consultez Éditions.	flexible
Port	string	Le numéro de port du cluster. Valeur par défaut : 3306.	3306
LockMode	string	Le mode de verrouillage du cluster. Valeurs valides : Unlock : le cluster n'est pas verrouillé. ManualLock : le cluster est verrouillé manuellement. LockByExpiration : le cluster est verrouillé automatiquement en raison de son expiration. LockByRestoration : le cluster est verrouillé automatiquement avant une restauration. LockByDiskQuota : le cluster est verrouillé automatiquement car l'espace de stockage est plein. Cela se produit lorsque l'espace de stockage utilisé par les données atteint 90 % de la limite supérieure.	Unlock
StorageResource	string	La spécification de ressource de stockage utilisée en mode élastique pour les lectures et écritures de données. L'augmentation de cette ressource améliore les capacités de lecture et d'écriture du cluster.	8Core32GB
ExecutorCount	string	Le nombre de nœuds de calcul utilisés par le cluster en mode élastique.	1
DBClusterId	string	L'identifiant du cluster.	am-bp163885f8q21****
ConnectionString	string	Le point de terminaison public du cluster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	L'identifiant de l'instance ApsaraDB RDS source pour la synchronisation. Ce paramètre n'est renvoyé que pour les instances analytiques MySQL.	rm-bp11q28kvl688****
DBClusterType	string	Le type de cluster. Valeurs valides : Common : cluster standard. RDS_ANALYSIS : instance analytique MySQL.	Common
CommodityCode	string	Le code de produit. La valeur est fixée à ads.	ads
ExpireTime	string	L'heure d'expiration du cluster. L'heure est affichée en UTC au format yyyy-MM-ddTHH:mm:ssZ. Exemple : 2999-09-08T16:00:00Z. Remarque Si le cluster utilise la méthode de facturation par abonnement, l'heure d'expiration réelle est renvoyée. Si le cluster utilise la méthode de facturation à l'usage, la valeur fixe 2999-09-08T16:00:00Z est renvoyée.	2999-09-08T16:00:00Z
DBNodeStorage	integer	L'espace de stockage du cluster. Unité : Go.	300
DBNodeClass	string	Les spécifications de nœud.	E8
LockReason	string	La raison pour laquelle le cluster est verrouillé. Remarque Ce paramètre n'est renvoyé que lorsque le cluster est verrouillé. La valeur est fixée à instance_expire.	instance_expired
VPCId	string	L'identifiant du cloud privé virtuel (VPC).	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	L'identifiant de la région du cluster.	cn-hangzhou
ComputeResource	string	La spécification de ressource de calcul utilisée en mode élastique pour le calcul des données. L'augmentation des ressources de calcul accélère la vitesse des requêtes. Vous pouvez mettre à l'échelle les ressources de calcul de manière élastique en fonction des exigences de performances réelles du cluster.	8Core32GB
ElasticIOResource	integer	La ressource d'E/S élastique (EIU). Pour plus d'informations, consultez Présentation de l'EIU. Remarque Ce paramètre n'est renvoyé que pour les clusters en mode élastique.	0
VSwitchId	string	L'identifiant du vSwitch.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	La version du moteur de base de données. Seule la version 3.0 est prise en charge.	3.0
VPCCloudInstanceId	string	L'identifiant de l'instance connectée au VPC.	am-bp163885f8q21****-controller
DBClusterStatus	string	L'état du cluster. Pour plus d'informations, consultez État du cluster.	Running
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	Le type de réseau du cluster. Seul le VPC est pris en charge.	vpc
DBClusterDescription	string	La description du cluster.	adb_test
ZoneId	string	L'identifiant de la zone du cluster.	cn-hangzhou-h
Category	string	L'édition. Valeurs valides : BASIC : édition de base en mode réservé. CLUSTER : édition cluster en mode réservé. MIXED_STORAGE : édition cluster en mode élastique. Remarque Pour plus d'informations sur les éditions, consultez Éditions.	MIXED_STORAGE
Engine	string	Le moteur de base de données du cluster. La valeur est fixée à AnalyticDB.	AnalyticDB
InnerIp	string	L'adresse IP publique.	10.1.xx.xx
InnerPort	string	Le numéro de port.	3306
TaskInfo	object	Les informations de progression de la tâche.
Name	string	Le nom de la tâche.	analyticDBFlexibleScaleOut
Status	string	L'état de la tâche. Valeurs valides : NOT_RUN : la tâche est en attente d'exécution. RUNNING : la tâche est en cours d'exécution. SUCCEED : la tâche est terminée. Valeurs valides : SUCCEED : Terminée. RUNNING : En cours d'exécution. NOT_RUN : En attente d'exécution.	RUNNING
Progress	string	La progression de la tâche. Unité : %.	10
StepList	object
StepList	array<object>	Les étapes de la tâche.
	object	Les étapes de la tâche.
StepName	string	Le nom de l'étape.	ApplyResource
StepDesc	string	La description de l'étape.	Apply resource
StepStatus	string	L'état de l'étape. Valeurs valides : NOT_RUN : l'étape est en attente d'exécution. RUNNING : l'étape est en cours d'exécution. SUCCEED : l'étape est terminée. Valeurs valides : SUCCEED : Terminée. RUNNING : En cours d'exécution. NOT_RUN : En attente d'exécution.	SUCCEED
StepProgress	string	La progression de l'étape. Unité : %.	50
StartTime	string	L'heure de début de l'étape. L'heure est affichée au format YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	L'heure de fin de l'étape. L'heure est affichée au format YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductVersion	string	L'édition du produit. Valeurs valides : BasicVersion : édition de base. EnterpriseVersion : édition entreprise.	EnterpriseVersion

Exemples

JSON format

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "8Core32GB",
        "ExecutorCount": "1",
        "DBClusterId": "am-bp163885f8q21****",
        "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "8Core32GB",
        "ElasticIOResource": 0,
        "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "InnerIp": "10.1.xx.xx",
        "InnerPort": "3306",
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Application de la ressource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
500	InternalError	An error occurred while processing your request.	Une erreur interne du système s'est produite. Réessayez plus tard.
503	ServiceUnavailable	An error occurred while processing your request.	Le système est temporairement indisponible. Réessayez plus tard.

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

Notes de version

Consultez Notes de version pour la liste complète.