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

Consulta os endpoints de um cluster de borda para PolarDB no ENS.

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

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	2DC120BF-6EBA-4C63-BE99-B09F9E******
Items	array<object>	Os detalhes dos endpoints do cluster.
	array<object>
DBEndpointId	string	O ID do endpoint.	pe-*************
PolarSccTimeoutAction	string	A política de tempo limite de consistência global. Valores válidos: 0: Envia a solicitação para o nó primário. 2: Degrada a solicitação. Se uma leitura de consistência global atingir o tempo limite, a consulta será automaticamente degradada para uma solicitação comum. O cliente não recebe uma mensagem de erro.	0
DBClusterId	string	O ID do cluster.	pc-bp1s826a1up******
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
DBEndpointDescription	string	O nome do endpoint.	test
PolarSccWaitTimeout	string	O período de tempo limite para consistência global.	100
NodeWithRoles	string	A função de cada nó no endpoint. O nó primário tem a função Writer. Como vários nós somente leitura podem ser adicionados a um endpoint, cada nó somente leitura recebe um nome de função com um sufixo numérico, como Reader1 e Reader2.	Reader1
AutoAddNewNodes	string	Especifica se novos nós são adicionados automaticamente ao endpoint padrão do cluster. Valores válidos: Enable. Disable.	Enable
EndpointType	string	O tipo de endpoint do cluster. Valores válidos: Cluster: o endpoint padrão do cluster. Primary: o endpoint primário. Custom: um endpoint de cluster personalizado.	Custom
AddressItems	array<object>	As informações da string de conexão.
	object
DashboardUsed	boolean	Specifies whether the endpoint is the dashboard endpoint of a PolarDB search node. Valid values: True: Yes. False: No.	True
PrivateZoneConnectionString	string	The private domain name that is bound to the endpoint.	*..*.com
VPCId	string	The ID of the virtual private cloud (VPC).	vpc-***************
VSwitchId	string	The virtual switch ID.	vsw-************
Port	string	The port number.	1521
VpcInstanceId	string	The VPC instance ID.	pe-*************
ConnectionString	string	The connection string.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
IPAddress	string	The IP address.	192.*..**
NetType	string	The network type. Valid values: Public: Internet. Private: internal network.	Private
SccMode	string	Especifica se a consistência global (modo de alto desempenho) está ativada para o nó. Valores válidos: on: ativada. off: desativada.	on
EndpointConfig	string	As configurações avançadas do endpoint do cluster. DistributedTransaction: O status da divisão de transações. Valores válidos: on: A divisão de transações está ativada. off: A divisão de transações está desativada. 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 para agendamento automático com base nas cargas. O valor é fixo como load. MasterAcceptReads: Especifica 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\"}

Exemplos

Resposta de sucesso

JSON formato

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

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.