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

Consulta os endpoints de um cluster PolarDB.

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

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. Nota Você pode chamar a operação DescribeDBClusters para encontrar os IDs de todos os clusters em sua conta.	pc-*************
DBEndpointId	string	Não	O ID do endpoint do cluster.	pe-*************
DescribeType	string	Não	Especifica se devem ser retornadas informações sobre nós de IA.	AI
PolarFsInstanceId	string	Não	O ID da instância PolarFS.	pfs-test*****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	2DC120BF-6EBA-4C63-BE99-B09F9E******
Items	array<object>	Uma lista de endpoints do cluster.
	array<object>
Nodes	string	A lista de nós configurados para o endpoint.	pi-*************,pi-*************
ReadWriteMode	string	O modo de leitura/gravação. Valores válidos: ReadWrite: leitura e gravação (divisão automática de leitura/gravação). ReadOnly: somente leitura.	ReadOnly
AddressItems	array<object>	Os endereços de conexão do endpoint.
	object
VSwitchId	string	The vSwitch ID.	vsw-************
PrivateZoneConnectionString	string	The connection string for the private domain name.	*..*.com
ConnectionString	string	The connection string.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
NetType	string	The network type. Valid values: Public: public network Private: private network	Private
Port	string	The port.	1521
VpcInstanceId	string	The VPC instance ID. Nota This parameter is returned only for PolarDB for MySQL clusters.	pe-*************
VPCId	string	The VPC ID.	vpc-***************
IPAddress	string	The IP address.	192.*..**
DashboardUsed	boolean	Indicates whether the endpoint is a dashboard endpoint for a PolarDB Search node. True: Yes False: No	True
DBEndpointId	string	O ID do endpoint.	pe-*************
EndpointConfig	string	As configurações avançadas do endpoint do cluster. DistributedTransaction: O status de divisão de transações. Valores válidos: on: ativado off: desativado ConsistLevel: O nível de consistência. Valores válidos: 0: consistência eventual 1: consistência de sessão 2: consistência global LoadBalanceStrategy: A política de balanceamento de carga. O valor é fixo em load, que indica agendamento baseado em carga. MasterAcceptReads: Indica se o nó primário aceita solicitações de leitura. Valores válidos: on: O nó primário aceita solicitações de leitura. off: O nó primário não aceita solicitações de leitura.	{\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
DBEndpointDescription	string	O nome do endpoint.	test
EndpointType	string	O tipo do endpoint do cluster. Valores válidos: Cluster: o endpoint de cluster padrão. Primary: o endpoint primário. Custom: um endpoint de cluster personalizado.	Custom
AutoAddNewNodes	string	Indica se novos nós são adicionados automaticamente ao endpoint de cluster padrão. Valores válidos: Enable Disable	Enable
DBClusterId	string	O ID do cluster.	pc-bp1s826a1up******
SccMode	string	Indica se a consistência global (modo de alto desempenho) está ativada para o nó. Valores válidos: on: ativado off: desativado	on
PolarSccTimeoutAction	string	A política para tratamento de timeouts de leitura com consistência global. Valores válidos: 0: Redireciona a solicitação para o nó primário. 2: Faz downgrade da solicitação. Se uma leitura com consistência global expirar, o sistema automaticamente faz downgrade da consulta para uma leitura sem consistência, e o cliente não recebe um erro.	0
PolarSccWaitTimeout	string	O período de timeout para leituras com consistência global.	100
NodeWithRoles	string	O papel de cada nó no endpoint. O nó primário tem o papel Writer. Os nós somente leitura têm papéis numerados, como Reader1, Reader2, e assim por diante. Nota Este parâmetro é suportado apenas por clusters PolarDB for PostgreSQL e clusters PolarDB for PostgreSQL (compatível com Oracle).	Reader1
ServiceName	string	O nome do serviço.	test-name
NetType	string	O tipo de rede. Valores válidos: Public: rede pública Private: rede privada	Private
VPCId	string	O ID da VPC.	vpc-***************
Port	string	A porta.	1521
ConnectionString	string	A string de conexão.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
Protocol	string	O tipo de protocolo.	http

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2DC120BF-6EBA-4C63-BE99-B09F9E******",
  "Items": [
    {
      "Nodes": "pi-***************,pi-***************",
      "ReadWriteMode": "ReadOnly",
      "AddressItems": [
        {
          "VSwitchId": "vsw-************",
          "PrivateZoneConnectionString": "***.***.**.com",
          "ConnectionString": "********.rwlb.polardb-pg-public.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "1521",
          "VpcInstanceId": "pe-*************",
          "VPCId": "vpc-***************",
          "IPAddress": "192.***.***.***",
          "DashboardUsed": true
        }
      ],
      "DBEndpointId": "pe-*************",
      "EndpointConfig": "{\\\"DistributedTransaction\\\":\\\"off\\\",\\\"ConsistLevel\\\":\\\"0\\\",\\\"LoadBalanceStrategy\\\":\\\"load\\\",\\\"MasterAcceptReads\\\":\\\"on\\\"}",
      "DBEndpointDescription": "test",
      "EndpointType": "Custom",
      "AutoAddNewNodes": "Enable",
      "DBClusterId": "pc-bp1s826a1up******",
      "SccMode": "on",
      "PolarSccTimeoutAction": "0",
      "PolarSccWaitTimeout": "100",
      "NodeWithRoles": "Reader1",
      "ServiceName": "test-name",
      "NetType": "Private",
      "VPCId": "vpc-***************",
      "Port": "1521",
      "ConnectionString": "********.rwlb.polardb-pg-public.rds.aliyuncs.com",
      "Protocol": "http"
    }
  ]
}

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.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.