DescribeDBClusters - ApsaraDB for ClickHouse: Central de Documentação do Alibaba Cloud

Descreve os clusters do ApsaraDB for ClickHouse em uma região especificada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

clickhouse:DescribeDBClusters

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
DBClusterIds	string	Não	O ID do cluster. Nota Se você não especificar este parâmetro, as informações de todos os clusters serão consultadas por padrão.	cc-bp108z124a8o7****
DBClusterDescription	string	Não	A descrição do cluster.	cc-bp108z124a8o7****
DBClusterStatus	string	Não	O estado do cluster. Valores válidos: Preparing: O cluster está sendo preparado. Creating: O cluster está sendo criado. Running: O cluster está em execução. Deleting: O cluster está sendo excluído. SCALING_OUT: O cluster está sendo expandido.	Running
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 (Padrão) 50 100	30
PageNumber	integer	Não	O número da página.	1
Tag	array<object>	Não	As tags.
	object	Não	A tag.
Key	string	Não	A chave da tag.	department
Value	string	Não	O valor da tag.	it
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o cluster pertence.	rg-4690g37929****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de entradas.	1
PageSize	integer	O número de entradas retornadas por página. Valores válidos: 30 (Padrão) 50 100	30
RequestId	string	O ID da solicitação.	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	O número da página.	1
DBClusters	object
DBCluster	array<object>	A lista de clusters.
	array<object>	A lista de 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. Nota 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`. Nota 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. Nota 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. Nota 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. Nota 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

Exemplos

Resposta de sucesso

JSON formato

{
  "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"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
403	Forbidden	User not authorized to operate on the specified resource.	The account is not granted permission to manipulate the resource
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.