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

Consulta as informações de rede de um cluster do 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:DescribeDBClusterNetInfoItems

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	cc-bp1qx68m06981****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NetInfoItems	object
NetInfoItem	array<object>	Uma lista de informações de rede.
	object	Uma lista de informações de rede.
VpcId	string	The VPC ID. Nota This parameter is empty if the network type of the endpoint is `Public`.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	The vSwitch ID. Nota This parameter is empty if the network type of the endpoint is `Public`.	vsw-bp1gzt31twhlo0sa5****
ConnectionString	string	The database endpoint.	cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com
JdbcPort	string	The Java Database Connectivity (JDBC) port number.	3306
NetType	string	The network type of the endpoint. Valid values: Public: the public network. VPC: a VPC.	VPC
HttpPort	string	The HTTP port number.	8123
IPAddress	string	The IP address.	10.255.234.251
HttpsPort	string	The HTTPS port number.	8443
MySQLPort	string	The MySQL port number.	9004
ClusterNetworkType	string	O tipo de rede. Somente VPC é suportado.	VPC
RequestId	string	O ID da solicitação.	9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
EnableSLB	boolean	Indica se o Server Load Balancer (SLB) está ativado na VPC. Valores válidos: true: ativado. false: desativado.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "NetInfoItems": {
    "NetInfoItem": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "ConnectionString": "cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com",
        "JdbcPort": "3306",
        "NetType": "VPC",
        "HttpPort": "8123",
        "IPAddress": "10.255.234.251",
        "HttpsPort": "8443",
        "MySQLPort": "9004"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "EnableSLB": true
}

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.	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.