DescribeDBClusterNetInfo - PolarDB: Central de Documentação do Alibaba Cloud

Consulta os endpoints de banco de dados.

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

polardb:DescribeDBClusterNetInfo

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-****************
ConnectionStringType	string	Não	O tipo do endpoint. Valores válidos: Normal: o endpoint primário ReadWriteSplitting: o endpoint do cluster MPP: o endpoint Massively Parallel Processing (MPP)	Normal

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações sobre o endpoint do cluster.
DBClusterNetInfos	object
DBClusterNetInfo	array<object>	As informações sobre o endpoint do cluster.
	object	As informações sobre o endpoint do cluster.
VSwitchId	string	The ID of the vSwitch.	vsw-bp1li3eavsz8oaexq15dw
ConnectionStringType	string	The type of the endpoint. Valid values: Normal: the primary endpoint ReadWriteSplitting: the cluster endpoint MPP: the MPP endpoint	MPP
ConnectionString	string	The database endpoint.	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	The network type of the IP address. Valid values: Public: the Internet. Inner: the classic network. Private: a virtual private cloud (VPC).	Public
Port	string	The port number.	1521
VPCId	string	The ID of the VPC.	vpc-***************
IPAddress	string	The IP address.	121...173
ClusterNetworkType	string	O tipo de rede do cluster. O valor é fixo como VPC.	VPC
RequestId	string	O ID da solicitação.	72D99256-ACF1-5F86-831F-8CB53E9C23ED
DBNodeNetInfos	object
DBNodeNetInfo	array<object>	As informações sobre o endpoint do nó.
	array<object>	As informações sobre o endpoint do nó.
NetInfos	object
NetInfo	array<object>	The information about the node endpoint.
	object	The information about the node endpoint.
VSwitchId	string	The ID of the vSwitch.	vsw-*************
ConnectionString	string	The database endpoint.	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	The network type of the IP address. Valid values: Public: the Internet. Inner: the classic network. Private: a VPC.	Public
Port	string	The port number.	5432
VPCId	string	The ID of the VPC.	vpc-****************
IPAddress	string	The IP address.	47...203
DBNodeRole	string	The role of the node. Valid values: Writer: the primary node. Reader: a read-only node. ColumnReader: a column store read-only node. AI: an AI node.	Writer
DBInstanceId	string	The instance ID.	pc-*************

Exemplos

Resposta de sucesso

JSON formato

{
  "DBClusterNetInfos": {
    "DBClusterNetInfo": [
      {
        "VSwitchId": "vsw-bp1li3eavsz8oaexq15dw",
        "ConnectionStringType": "MPP",
        "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com",
        "IPType": "Public",
        "Port": "1521",
        "VPCId": "vpc-***************",
        "IPAddress": "121.*.*.173"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "72D99256-ACF1-5F86-831F-8CB53E9C23ED",
  "DBNodeNetInfos": {
    "DBNodeNetInfo": [
      {
        "NetInfos": {
          "NetInfo": [
            {
              "VSwitchId": "vsw-*************",
              "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com\n",
              "IPType": "Public",
              "Port": "5432",
              "VPCId": "vpc-****************",
              "IPAddress": "47.*.*.203"
            }
          ]
        },
        "DBNodeRole": "Writer",
        "DBInstanceId": "pc-*************"
      }
    ]
  }
}

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 specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.