DescribeDBClusters - - Centre de documentation Alibaba Cloud

Décrit les clusters ApsaraDB for ClickHouse dans une région spécifiée.

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.

clickhouse:DescribeDBClusters

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
DBClusterIds	string	Non	L'identifiant du cluster.	cc-bp108z124a8o7****
DBClusterDescription	string	Non	La description du cluster.	cc-bp108z124a8o7****
DBClusterStatus	string	Non	L'état du cluster. Valeurs valides :	Running
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides :	30
PageNumber	integer	Non	Le numéro de page.	1
Tag	array<object>	Non	Les balises.
	object	Non	La balise.
Key	string	Non	La clé de la balise.	department
Value	string	Non	La valeur de la balise.	it
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le cluster appartient.	rg-4690g37929****

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre total d'entrées.	1
PageSize	integer	Le nombre d'entrées retournées par page. Valeurs valides :	30
RequestId	string	L'identifiant de la requête.	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	Le numéro de page.	1
DBClusters	object
DBCluster	array<object>	La liste des clusters.
	array<object>	La liste des clusters.
VpcId	string	The VPC ID.	vpc-bp175iuvg8nxqraf2****
DBNodeCount	integer	The number of nodes. For a single-replica edition cluster, the value is from 1 to 48. For a dual-replica edition cluster, the value is from 1 to 24.	2
CreateTime	string	The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2021-10-28T07:24:45Z
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
Tags	object
Tag	array<object>	The list of tags.
	object	The tag.
Key	string	The key of the tag.	department
Value	string	The value of the tag.	it
StorageType	string	The storage class. Valid values: CloudESSD: ESSD PL1. CloudESSD_PL2: ESSD PL2. CloudESSD_PL3: ESSD PL3. CloudEfficiency: ultra disk.	CloudESSD
Port	integer	The HTTP port.	8123
LockMode	string	The lock mode 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. LockByRestoration: The cluster is automatically locked before a rollback. LockByDiskQuota: The cluster is automatically locked because the disk is full.	Unlock
Bid	string	The site ID. Valid values: 26842: Alibaba Cloud China Website (www.aliyun.com). 26888: Alibaba Cloud International Website (www.alibabacloud.com).	26842
IsExpired	string	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.	false
VpcCloudInstanceId	string	The ID of the VPC instance.	vpc-bp175iuvg8nxqraf2****
ScaleOutStatus	object	The data migration status.
Progress	string	The data migration progress in percentage. Remarque This parameter is returned only when the cluster is in the SCALING_OUT state.	0
Ratio	string	The data migration progress. The format is `Data migrated/Total data`. Remarque This parameter is returned only when the cluster is in the SCALING_OUT state.	0MB/60469MB
ScaleOutDisableWriteWindows	string	The write-blocking window for the upgrade or downgrade.	2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
DBClusterId	string	The cluster ID.	cc-bp108z124a8o7****
ConnectionString	string	The VPC endpoint.	cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com
CommodityCode	string	The commodity code.	clickhouse_go_public_cn
ExpireTime	string	The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format. Remarque Pay-as-you-go clusters do not expire. This parameter is empty for pay-as-you-go clusters.	2011-05-30T12:11:4Z
DBNodeStorage	integer	The storage space of a single node. The value ranges from 100 GB to 32,000 GB. Remarque The step size is 100 GB.	100
DBNodeClass	string	The instance type of the cluster. For single-replica edition clusters, valid values are: LS20: Large storage, 20 cores, 88 GB memory. LS40: Large storage, 40 cores, 176 GB memory. LS80: Large storage, 80 cores, 352 GB memory. S8: Standard, 8 cores, 32 GB memory. S16: Standard, 16 cores, 64 GB memory. S32: Standard, 32 cores, 128 GB memory. S64: Standard, 64 cores, 256 GB memory. S80: Standard, 80 cores, 384 GB memory. S104: Standard, 104 cores, 384 GB memory. For dual-replica edition clusters, valid values are: LC20: Large storage, 20 cores, 88 GB memory. LC40: Large storage, 40 cores, 176 GB memory. LC80: Large storage, 80 cores, 352 GB memory. C8: Standard, 8 cores, 32 GB memory. C16: Standard, 16 cores, 64 GB memory. C32: Standard, 32 cores, 128 GB memory. C64: Standard, 64 cores, 256 GB memory. C80: Standard, 80 cores, 384 GB memory. C104: Standard, 104 cores, 384 GB memory. For single-replica edition clusters, valid values are: - S4: 4 cores, 16 GB memory. - S8: 8 cores, 32 GB memory. S16: 16 cores, 64 GB memory. S32: 32 cores, 128 GB memory. S64 : 64 cores, 256 GB memory. S104: 104 cores, 384 GB memory. For dual-replica edition clusters, valid values are: - C4: 4 cores, 16 GB memory. - C8: 8 cores, 32 GB memory. - C16: 16 cores, 64 GB memory. - C32: 32 cores, 128 GB memory. - C64 : 64 cores, 256 GB memory. - C104: 104 cores, 384 GB memory.	C8
AliUid	string	The Alibaba Cloud account ID.	140692647406****
LockReason	string	The reason why the cluster was locked. Remarque This parameter is empty if the cluster is not locked.	DISK_FULL
RegionId	string	The region ID.	cn-hangzhou
VSwitchId	string	The vSwitch ID.	vsw-bp1gzt31twhlo0sa5****
DBClusterStatus	string	The state 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. SCALING_OUT: The cluster is being scaled out.	Running
DBClusterDescription	string	The cluster description.	test
DBClusterNetworkType	string	The network type. Only VPC is supported.	VPC
ZoneId	string	The zone ID.	cn-hangzhou-h
Category	string	The edition of the cluster. Valid values: Basic: Single-replica Edition. HighAvailability: Dual-replica Edition.	Basic
ControlVersion	string	The version of the backend management system. Valid values: v1 v2	v1
ExtStorageType	string	The extended storage class. Valid values: CloudSSD: standard SSD. CloudESSD: ESSD PL1. CloudESSD_PL2: ESSD PL2. CloudESSD_PL3: ESSD PL3. CloudEfficiency: ultra disk.	CloudESSD
ExtStorageSize	integer	The extended storage space.	100GB
ResourceGroupId	string	The ID of the resource group to which the cluster belongs.	rg-4690g37929****
DbVersion	string	The kernel version of the cluster.	23.8

Exemples

JSON format

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "DBClusters": {
    "DBCluster": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "DBNodeCount": 2,
        "CreateTime": "2021-10-28T07:24:45Z",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "it"
            }
          ]
        },
        "StorageType": "CloudESSD",
        "Port": 8123,
        "LockMode": "Unlock",
        "Bid": "26842",
        "IsExpired": "false",
        "VpcCloudInstanceId": "vpc-bp175iuvg8nxqraf2****",
        "ScaleOutStatus": {
          "Progress": "0",
          "Ratio": "0MB/60469MB"
        },
        "ScaleOutDisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
        "DBClusterId": "cc-bp108z124a8o7****",
        "ConnectionString": "cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com",
        "CommodityCode": "clickhouse_go_public_cn",
        "ExpireTime": "2011-05-30T12:11:4Z",
        "DBNodeStorage": 100,
        "DBNodeClass": "C8",
        "AliUid": "140692647406****",
        "LockReason": "DISK_FULL",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "DBClusterStatus": "Running",
        "DBClusterDescription": "test",
        "DBClusterNetworkType": "VPC",
        "ZoneId": "cn-hangzhou-h",
        "Category": "Basic",
        "ControlVersion": "v1",
        "ExtStorageType": "CloudESSD",
        "ExtStorageSize": 0,
        "ResourceGroupId": "rg-4690g37929****",
        "DbVersion": "23.8"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
500	InternalError	An error occurred while processing your request.
403	Forbidden	User not authorized to operate on the specified resource.
503	ServiceUnavailable	An error occurred while processing your request.

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

Notes de version

Consultez Notes de version pour la liste complète.