DescribeDBClusters - AnalyticDB - Centre de documentation Alibaba Cloud

Consulte les clusters de l'édition Data Lakehouse dans la région de destination.

Description de l'opération

Pour obtenir la liste actuelle des points de terminaison de service, consultez la section Points de terminaison de service.

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

list

*DBClusterLakeVersion

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

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	L'identifiant du cluster. Si vous omettez ce paramètre, l'opération renvoie des informations sur tous les clusters de la région spécifiée.	amv-bp1r053byu48p****
DBClusterDescription	string	Non	La description du cluster. Ne doit pas commencer par `http://` ou `https://`. La description doit comporter de 2 à 256 caractères.	test
DBClusterStatus	string	Non	L'état du cluster. Valeurs valides : Preparing : Le cluster est en cours de préparation. Creating : Le cluster est en cours de création. Running : Le cluster est en cours d'exécution. Deleting : Le cluster est en cours de suppression. Restoring : Le cluster est en cours de restauration à partir d'une sauvegarde. ClassChanging : Les spécifications du cluster sont en cours de modification. NetAddressCreating : Une connexion réseau est en cours de création pour le cluster. NetAddressDeleting : La connexion réseau du cluster est en cours de suppression. NetAddressModifying : La connexion réseau du cluster est en cours de modification.	Running
PageSize	integer	Non	Le nombre d'entrées à renvoyer 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. Valeur par défaut : 1.	1
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Si vous omettez ce paramètre, l'opération renvoie des informations sur les clusters de tous les groupes de ressources.	rg-4690g37929****
Tag	array<object>	Non	Les balises permettant de filtrer les clusters.
	object	Non	Informations sur une balise de cluster.
Key	string	Non	La clé de la balise.	tag1
Value	string	Non	La valeur de la balise.	test1
ProductVersion	string	Non	La version du produit. Valeurs valides : EnterpriseVersion : édition Entreprise. BasicVersion : édition de base. Remarque Si vous omettez ce paramètre, l'opération renvoie les clusters de toutes les versions du produit.	BasicVersion
DBClusterVersion	string	Non	La version du cluster. Valeurs valides : 3.0 : édition Data Warehouse. 5.0 (par défaut) : inclut les éditions Lakehouse, Enterprise et Basic. All : toutes les éditions, y compris les éditions Data Warehouse, Lakehouse, Enterprise et Basic.	5.0

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre total d'entrées retournées.	1
PageSize	integer	Le nombre d'entrées par page.	30
RequestId	string	L'identifiant de la requête.	A5EDBA27-AF3E-5966-9503-FD1557E19167
PageNumber	integer	Le numéro de page.	1
Items	object
DBCluster	array<object>	Les détails des clusters.
	array<object>	Les détails du cluster.
Expired	string	Indicates whether the subscription cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired. Remarque If a subscription cluster expires, it is locked and may be released after a period of time. We recommend that you renew the cluster. For more information, see Renewal. This parameter is not returned for pay-as-you-go clusters.	false
CreateTime	string	The creation time of the cluster. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ.	2022-04-01T09:50:18Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Mode	string	The mode of the cluster. A value of flexible indicates that the cluster is in elastic mode.	flexible
Port	string	The port number of the cluster.	3306
LockMode	string	The lock state of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked upon expiration.	Unlock
StorageResource	string	The amount of reserved storage resources. An AnalyticDB Compute Unit (ACU) is equivalent to 1 vCPU and 4 GB of memory. Storage resources are used for data read and write operations. Increasing storage resources can improve the read and write performance of the cluster.	24ACU
DBClusterId	string	The ID of the Data Lakehouse Edition cluster.	amv-bp163885f8q21****
ConnectionString	string	The public endpoint of the cluster.	amv-bp163885f8q21****.ads.aliyuncs.com
DBClusterType	string	The type of the cluster. A value of Common indicates a regular cluster.	Common
CommodityCode	string	The commodity code of the cluster. Valid values: ads: a pay-as-you-go cluster. ads_pre: a subscription cluster.	ads_pre
ExpireTime	string	The expiration time of the cluster. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ. Remarque If the cluster has a subscription billing method, the actual expiration time is returned. If the cluster has a pay-as-you-go billing method, no value is returned.	2022-07-01T09:50:18Z
LockReason	string	The reason that the cluster is locked. Remarque This parameter is returned only when the cluster is locked. The value is fixed as instance_expired.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID.	vpc-bp13h7uzhulpuxvnp****
RegionId	string	The ID of the region where the cluster resides.	cn-hangzhou
ComputeResource	string	The amount of reserved computing resources. An AnalyticDB Compute Unit (ACU) is equivalent to 1 vCPU and 4 GB of memory. Computing resources are used for data computation. You can increase computing resources to accelerate queries and elastically scale them based on the cluster performance.	16ACU
VSwitchId	string	The vSwitch ID.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	The database engine version. The only supported version is 5.0.	5.0
DBClusterStatus	string	The status of the cluster. Valid values: Preparing: The cluster is being prepared. Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being deleted. Restoring: The cluster is being restored from a backup. ClassChanging: The cluster specifications are being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted. NetAddressModifying: A network connection is being modified.	Running
ResourceGroupId	string	The ID of the resource group.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. The only supported network type is VPC.	VPC
DBClusterDescription	string	The description of the cluster.	adb_test
ZoneId	string	The ID of the zone where the cluster resides.	cn-hangzhou-h
Engine	string	The database engine of the cluster. The value is fixed as AnalyticDB.	AnalyticDB
ReservedACU	string	The amount of remaining reserved computing resources. An ACU is equivalent to 1 vCPU and 4 GB of memory.	32ACU
Tags	object
Tag	array<object>	The list of tags.
	object	The tags.
Key	string	The tag key. Remarque You can call the TagResources operation to add tags to the cluster.	tag1
Value	string	The tag value.	test1
Category	string	The edition of the cluster. This parameter is returned only for clusters in Data Warehouse Edition. Valid values: BASIC: Basic Edition in reserved mode. CLUSTER: Cluster Edition in reserved mode. MIXED_STORAGE: Elastic Mode Cluster Edition (New). Remarque For more information about cluster editions, see Product editions.	MIXED_STORAGE
InnerPort	string	The internal port of the cluster.	3306
VPCCloudInstanceId	string	The internal endpoint.	am-bp163885f8q21****-controller
InnerIp	string	The internal IP address of the cluster.	10.1.xx.xx
DtsJobId	string	The ID of the Data Transmission Service (DTS) synchronization task. This parameter is returned only for MySQL analysis instances.	dtsb1578j90XXXX
ElasticIOResource	integer	The number of Elastic IO Units (EIUs). For more information, see EIU details. Remarque This parameter is returned only for clusters in elastic mode.	2
RdsInstanceId	string	The ID of the source ApsaraDB RDS instance. This parameter is returned only for MySQL analysis instances.	rm-bp11q28kvl688****
ExecutorCount	string	The number of compute nodes in an elastic mode cluster.	1
DBNodeClass	string	The node specification. This parameter is returned only for clusters in Data Warehouse Edition.	E8
DiskType	string	The disk type of the cluster. Valid values: local_ssd: local SSD. cloud: standard cloud disk. cloud_ssd: SSD cloud disk. cloud_efficiency: ultra disk. cloud_essd: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. Remarque For more information about ESSDs, see ESSD specifications.	cloud_essd
DBNodeStorage	integer	The storage capacity of the cluster. Unit: GB.	300
DBNodeCount	integer	The number of node groups.	2
TaskInfo	object	Information about the task.
Name	string	The name of the task.	analyticDBFlexibleScaleOut
Status	string	The status of the task. Valid values: NOT_RUN: The task is pending. RUNNING: The task is running. SUCCEED: The task is complete.	RUNNING
Progress	string	The task progress, specified as a percentage.	10%
StepList	object
StepList	array<object>	The steps of the task.
	object	The steps of the task.
StepName	string	The name of the step.	ApplyResource
StepDesc	string	The description of the step.	Apply resource
StepStatus	string	The status of the step. Valid values: NOT_RUN: The step is pending. RUNNING: The step is running. SUCCEED: The step is complete.	SUCCEED
StepProgress	string	The progress of the step, specified as a percentage.	50%
StartTime	string	The time when the step started. The time is formatted as YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	The time when the step ended. The time is formatted as YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductForm	string	The product form. Valid values: LegacyForm: The legacy form. IntegrationForm: The integrated form.	IntegrationForm
ProductVersion	string	The product version. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion
ReservedNodeSize	string	The resource specification of a single reserved node.	8ACU
ReservedNodeCount	integer	The number of reserved resource nodes.	1
AINodeSpec	string	The AI node specification.	ADB.MLGrand.5
AINodeNumber	integer	The number of AI nodes.	1

Exemples

JSON format

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "Expired": "false",
        "CreateTime": "2022-04-01T09:50:18Z",
        "PayType": "Prepaid",
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-bp163885f8q21****",
        "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-07-01T09:50:18Z",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "16ACU",
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "32ACU",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Category": "MIXED_STORAGE",
        "InnerPort": "3306",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "InnerIp": "10.1.xx.xx",
        "DtsJobId": "dtsb1578j90XXXX",
        "ElasticIOResource": 2,
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "ExecutorCount": "1",
        "DBNodeClass": "E8",
        "DiskType": "cloud_essd",
        "DBNodeStorage": 300,
        "DBNodeCount": 2,
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10%",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50%",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductForm": "IntegrationForm",
        "ProductVersion": "EnterpriseVersion",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 1,
        "AINodeSpec": "ADB.MLGrand.5",
        "AINodeNumber": 1
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
500	InternalError	An error occurred while processing your request.	An internal error occurred. Please try again later.
503	ServiceUnavailable	An error occurred while processing your request.	The system is unavailable. Please try again later.

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

Notes de version

Consultez Notes de version pour la liste complète.