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

Consulta informações sobre um cluster ApsaraDB for ClickHouse especificado.

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:DescribeDBClusterAttribute

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster. Você pode chamar a operação DescribeDBClusters para consultar informações sobre todos os clusters na região de destino, incluindo IDs de cluster.	cc-bp108z124a8o7****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
DBCluster	object	As informações do cluster.
VpcId	string	O ID da VPC.	vpc-bp10tr8k9qasioaty****
SupportBackup	integer	Indica se o backup de dados é suportado. Valores válidos:	1
SupportOss	integer	Indica se o armazenamento híbrido de dados quentes e frios é suportado. Valores válidos:	1
EncryptionType	string	O tipo de criptografia. Valores válidos:	CloudDisk
DBNodeCount	integer	O número de nós.	1
MaintainTime	string	A janela de manutenção do cluster. O horário está no formato HH:mmZ-HH:mmZ (UTC).	00:00Z-01:00Z
CreateTime	string	A hora em que o cluster foi criado. O horário está no formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-12-13T11:33:11Z
PayType	string	O método de cobrança. Valores válidos:	Prepaid
Tags	object
Tag	array<object>	A lista de tags.
	object	A tag.
Key	string	A chave da tag.	department
Value	string	O valor da tag.	it
PublicConnectionString	string	O endpoint público.	cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com
StorageType	string	O tipo de armazenamento. Valores válidos:	CloudESSD
Port	integer	O número da porta HTTP.	8123
LockMode	string	O modo de bloqueio do cluster. Valores válidos:	Unlock
Bid	string	O ID do site. Valores válidos:	26842
EngineVersion	string	A versão do mecanismo DPI.	21.8.10.19
IsExpired	string	Indica se o cluster expirou. Valores válidos:	false
ScaleOutStatus	object	O status da migração de dados.
Progress	string	O progresso da migração de dados em porcentagem.	0
Ratio	string	O progresso da migração de dados no formato de volume de dados migrados/volume total de dados.	0MB/60469MB
LbKind	string	O tipo de balanceamento de carga.	clb
DBClusterId	string	O ID do cluster.	cc-bp108z124a8o7****
ConnectionString	string	O endpoint da VPC.	cc-bp1qx68m06981****.ads.rds.aliyuncs.com
EncryptionKey	string	A chave do Key Management Service (KMS).	685f416f-87c9-4554-8d3a-75b6ce25****
DBClusterType	string	O tipo de cluster. Valores válidos:	Common
CommodityCode	string	O código da mercadoria.	clickhouse_go_public_cn
ExpireTime	string	A hora de expiração do cluster. O horário está no formato yyyy-MM-ddTHH:mm:ssZ.	2022-11-11T16:00:00Z
DBNodeStorage	integer	A capacidade de armazenamento por nó. Unidade: GB.	100
DBNodeClass	string	As especificações do cluster. Valores válidos:	C8
AliUid	string	O ID da conta Alibaba Cloud.	140692647406****
LockReason	string	O motivo pelo qual o cluster está bloqueado.	DISK_FULL
RegionId	string	O ID da região.	cn-hangzhou
PublicPort	string	O número da porta TCP pública.	3306
VSwitchId	string	O ID do vSwitch.	vsw-bp1n874li1t5y57wi****
DBClusterStatus	string	O status do cluster. Valores válidos:	Running
DBClusterNetworkType	string	O tipo de rede. Apenas VPC é suportada.	vpc
DBClusterDescription	string	A descrição do cluster.	cc-bp108z124a8o7****
ZoneId	string	O ID da zona.	cn-hangzhou-h
Category	string	A configuração de réplicas. Valores válidos:	HighAvailability
Engine	string	O tipo de mecanismo.	ClickHouse
SupportMysqlPort	boolean	Indica se a porta MySQL é suportada. Valores válidos:	false
SupportHttpsPort	boolean	Indica se a porta HTTPS é suportada. Valores válidos:	false
ControlVersion	string	A versão do sistema de gerenciamento de backend. Valores válidos:	v1
PublicIpAddr	string	O endereço IP do endpoint público.	121.40.xx.xx
EngineMinorVersion	string	A versão secundária atual.	1.6.0
EngineLatestMinorVersion	string	A versão secundária mais recente disponível para atualização.	1.34.0
MaintainAutoType	boolean	O tipo de atualização. false indica atualização manual.	false
ExtStorageType	string	O tipo de armazenamento estendido. Valores válidos:	CloudESSD
ExtStorageSize	integer	A capacidade de armazenamento estendido. Unidade: GB.	500
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmyf65je6****
ZookeeperClass	string	As especificações do ZooKeeper.	4 núcleos, 8 GB
AppointmentRestartTime	string	A hora de reinicialização agendada. O horário está no formato YYYY-MM-DDThh:mm:ssZ (UTC).	2023-11-06T12:00:00Z
ZoneIdVswitchMap	object	A lista de IDs de vSwitch para instâncias multizona.	cn-shanghai-f: vsw-zm0n42d5vvuo****
AvailableUpgradeMajorVersion	object	As versões principais de destino disponíveis para atualização.	{"MajorVersion":"MinorVersion"}
AppointmentRestartNodeTime	string	A hora agendada para reiniciar nós específicos. O horário está no formato YYYY-MM-DDThh:mm:ssZ (UTC).	2023-11-06T12:00:00Z
AppointmentRestartNodeList	string	A lista de nós agendados para reinicialização.	ck-k1a976p3n******--clickhouse-s-0-r-0,ck-k1a976p3n****-**-clickhouse-s-0-r-1
AppointmentElectZookeeperTime	string	A hora agendada para eleição de líder. O horário está no formato YYYY-MM-DDThh:mm:ssZ (UTC).	2023-11-06T12:00:00Z
AppointmentElectZookeeperDisableWrite	boolean	A configuração de parada de escrita durante a eleição de líder. Valores válidos:	true
VpcIpAddr	string	O endereço IP da string de conectividade de rede VPC.	192.168.xx.xx
VpcCloudInstanceId	string	O ID do recurso VPC.	vpc-bp10tr8k9qasioaty****
WebUIStatus	string	O status do WebUI.	active
WebUISnatStatus	string	O status do gateway de rede pública do WebUI.	active
LangfuseInstanceIds	object
LangfuseInstanceId	array
	string
RequestId	string	O ID da solicitação.	05321590-BB65-4720-8CB6-8218E041CDD0

Exemplos

Resposta de sucesso

JSON formato

{
  "DBCluster": {
    "VpcId": "vpc-bp10tr8k9qasioaty****",
    "SupportBackup": 1,
    "SupportOss": 1,
    "EncryptionType": "CloudDisk",
    "DBNodeCount": 1,
    "MaintainTime": "00:00Z-01:00Z",
    "CreateTime": "2021-12-13T11:33:11Z",
    "PayType": "Prepaid",
    "Tags": {
      "Tag": [
        {
          "Key": "department",
          "Value": "it"
        }
      ]
    },
    "PublicConnectionString": "cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com",
    "StorageType": "CloudESSD",
    "Port": 8123,
    "LockMode": "Unlock",
    "Bid": "26842",
    "EngineVersion": "21.8.10.19",
    "IsExpired": "false",
    "ScaleOutStatus": {
      "Progress": "0",
      "Ratio": "0MB/60469MB"
    },
    "LbKind": "clb",
    "DBClusterId": "cc-bp108z124a8o7****",
    "ConnectionString": "cc-bp1qx68m06981****.ads.rds.aliyuncs.com",
    "EncryptionKey": "685f416f-87c9-4554-8d3a-75b6ce25****",
    "DBClusterType": "Common",
    "CommodityCode": "clickhouse_go_public_cn",
    "ExpireTime": "2022-11-11T16:00:00Z",
    "DBNodeStorage": 100,
    "DBNodeClass": "C8",
    "AliUid": "140692647406****",
    "LockReason": "DISK_FULL",
    "RegionId": "cn-hangzhou",
    "PublicPort": "3306",
    "VSwitchId": "vsw-bp1n874li1t5y57wi****",
    "DBClusterStatus": "Running",
    "DBClusterNetworkType": "vpc",
    "DBClusterDescription": "cc-bp108z124a8o7****",
    "ZoneId": "cn-hangzhou-h",
    "Category": "HighAvailability",
    "Engine": "ClickHouse",
    "SupportMysqlPort": false,
    "SupportHttpsPort": false,
    "ControlVersion": "v1",
    "PublicIpAddr": "121.40.xx.xx",
    "EngineMinorVersion": "1.6.0",
    "EngineLatestMinorVersion": "1.34.0",
    "MaintainAutoType": false,
    "ExtStorageType": "CloudESSD",
    "ExtStorageSize": 500,
    "ResourceGroupId": "rg-acfmyf65je6****",
    "ZookeeperClass": "4 núcleos, 8 GB",
    "AppointmentRestartTime": "2023-11-06T12:00:00Z",
    "ZoneIdVswitchMap": {
      "test": "test",
      "test2": 1
    },
    "AvailableUpgradeMajorVersion": {
      "MajorVersion": "MinorVersion"
    },
    "AppointmentRestartNodeTime": "2023-11-06T12:00:00Z",
    "AppointmentRestartNodeList": "ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1",
    "AppointmentElectZookeeperTime": "2023-11-06T12:00:00Z",
    "AppointmentElectZookeeperDisableWrite": true,
    "VpcIpAddr": "192.168.xx.xx",
    "VpcCloudInstanceId": "vpc-bp10tr8k9qasioaty****",
    "WebUIStatus": "active",
    "WebUISnatStatus": "active",
    "LangfuseInstanceIds": {
      "LangfuseInstanceId": [
        ""
      ]
    }
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.