Todos os produtos
Search
Central de documentação

PolarDB:ModifyDBClusterEndpointZonal

Última atualização: Jun 28, 2026

Modifica a string de conexão de um cluster de borda do 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:ModifyDBClusterEndpointZonal

update

*All Resource

*

Nenhuma Nenhuma

Sintaxe da solicitação

POST  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

Sim

O ID do endpoint do cluster.

pe-****************

Nodes

string

Não

Os nós somente leitura a serem adicionados ao endpoint. Separe vários IDs de nó com vírgulas (,). Se você não especificar este parâmetro, os nós originais serão mantidos.

Nota
  • Para o PolarDB for MySQL, especifique os IDs dos nós.

  • Para o PolarDB for PostgreSQL e PolarDB for PostgreSQL (compatível com Oracle), especifique os nomes das funções dos nós, como Writer,Reader1,Reader2.

  • Se você definir ReadWriteMode como ReadOnly, poderá anexar apenas um nó. No entanto, se esse nó falhar, o endpoint poderá ficar indisponível por até uma hora. Não use esta configuração em um ambiente de produção. Selecione pelo menos dois nós para melhorar a disponibilidade.

  • Se você definir ReadWriteMode como ReadWrite, deverá selecionar pelo menos dois nós. * Para o PolarDB for MySQL, você pode selecionar quaisquer dois nós. Se ambos os nós forem nós somente leitura, as solicitações de gravação serão enviadas para o nó primário. * Para o PolarDB for PostgreSQL e PolarDB for PostgreSQL (compatível com Oracle), você deve incluir o nó primário.

pi-**************,pi-*************

ReadWriteMode

string

Não

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

ReadWrite

AutoAddNewNodes

string

Não

Especifica se novos nós devem ser adicionados automaticamente a este endpoint. Valores válidos:

  • Enable: sim

  • Disable: não (padrão)

Enable

EndpointConfig

string

Não

As configurações avançadas do endpoint do cluster, que são especificadas no formato JSON. Você pode definir o nível de consistência, a divisão de transações, se o nó primário aceita solicitações de leitura, o pool de conexões e muito mais.

  • Para definir a política de balanceamento de carga, use o formato {\"LoadBalancePolicy\":\"policy\"}. Valores válidos:

    • 0: balanceamento de carga baseado em conexão (padrão)

    • 1: balanceamento de carga baseado em solicitação ativa

  • Para especificar se o nó primário aceita solicitações de leitura, use o formato {\"MasterAcceptReads\":\"value\"}. Valores válidos:

    • on: O nó primário aceita solicitações de leitura (padrão).

    • off: O nó primário não aceita solicitações de leitura.

  • Para configurar a divisão de transações, use o formato {\"DistributedTransaction\":\"value\"}. Valores válidos:

    • on: ativa a divisão de transações (padrão)

    • off: desativa a divisão de transações

  • Para definir o nível de consistência, use o formato {\"ConsistLevel\":\"level\"}. Valores válidos:

    • 0: consistência eventual (fraca)

    • 1: consistência de sessão (média) (padrão)

    • 2: consistência global (forte)

  • Para definir o período de tempo limite para uma leitura de consistência global, use o formato {\"ConsistTimeout\":\"timeout\"}. Valores válidos: 0 a 60000. Valor padrão: 20. Unidade: ms.

  • Para definir o período de tempo limite para uma leitura de consistência de sessão, use o formato {\"ConsistSessionTimeout\":\"timeout\"}. Valores válidos: 0 a 60000. Valor padrão: 0. Unidade: ms.

  • Para definir a política para um tempo limite de leitura de consistência global ou de sessão, use o formato {\"ConsistTimeoutAction\":\"policy\"}. Valores válidos:

    • 0: Envia a solicitação de leitura para o nó primário (padrão).

    • 1: O proxy retorna uma mensagem de erro `wait replication complete timeout, please retry` para o aplicativo.

  • Para configurar o pool de conexões, use o formato {\"ConnectionPersist\":\"pool_type\"}. Valores válidos:

    • off: desativa o pool de conexões (padrão)

    • Session: ativa o pool de conexões no nível de sessão

    • Transaction: ativa o pool de conexões no nível de transação

  • Para configurar consultas paralelas, use o formato {\"MaxParallelDegree\":\"value\"}. Valores válidos:

    • on: ativa consultas paralelas

    • off: desativa consultas paralelas (padrão)

  • Para configurar o roteamento automático entre row store e column store, use o formato {\"EnableHtapImci\":\"value\"}. Valores válidos:

    • on: ativa o roteamento automático entre row store e column store

    • off: desativa o roteamento automático entre row store e column store (padrão)

  • Para especificar se a proteção contra sobrecarga deve ser ativada, use o formato {\"EnableOverloadThrottle\":\"value\"}. Valores válidos:

    • on: ativa a proteção contra sobrecarga

    • off: desativa a proteção contra sobrecarga (padrão)

Nota
  • Você pode configurar a divisão de transações, especificar se o nó primário aceita solicitações de leitura, configurar o pool de conexões e ativar a proteção contra sobrecarga apenas quando o modo de leitura/gravação do endpoint do cluster para PolarDB for MySQL estiver definido como ReadWrite (divisão automática de leitura/gravação).

  • Se o modo de leitura/gravação de um endpoint de cluster para PolarDB for MySQL for ReadOnly, as políticas de balanceamento de carga baseadas em conexão e em solicitação ativa são suportadas. Se o modo de leitura/gravação for ReadWrite (divisão automática de leitura/gravação), apenas a política de balanceamento de carga baseada em solicitação ativa é suportada.

  • Você pode configurar o roteamento automático entre row store e column store quando o modo de leitura/gravação do endpoint do cluster para PolarDB for MySQL for ReadWrite (divisão automática de leitura/gravação), ou quando o modo de leitura/gravação for ReadOnly e a política de balanceamento de carga for baseada em solicitação ativa.

  • Apenas o PolarDB for MySQL suporta o nível de consistência global.

  • Se você definir ReadWriteMode como ReadOnly, poderá definir o nível de consistência apenas como 0.

  • Você pode definir o nível de consistência, a divisão de transações, se o nó primário aceita solicitações de leitura e o pool de conexões ao mesmo tempo. Por exemplo: {\"ConsistLevel\":\"1\",\"DistributedTransaction\":\"on\",\"ConnectionPersist\":\"Session\",\"MasterAcceptReads\":\"on\"}.

  • A configuração de divisão de transações é restringida pelo nível de consistência. Por exemplo, se o nível de consistência for 0, você não poderá ativar a divisão de transações. Se o nível de consistência for 1 ou 2, você poderá ativar a divisão de transações.

{\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}

DBEndpointDescription

string

Não

O nome do endpoint.

test

SccMode

string

Não

Especifica se o recurso de consistência global (modo de alto desempenho) deve ser ativado para o nó. Valores válidos:

  • ON: ativa o recurso

  • OFF: desativa o recurso

OFF

PolarSccWaitTimeout

string

Não

O período de tempo limite para consistência global.

100

PolarSccTimeoutAction

string

Não

A política para um tempo limite de consistência global. Valores válidos:

  • 0: Envia a solicitação para o nó primário.

  • 2: Degradação de tempo limite. Se uma leitura de consistência global atingir o tempo limite, a consulta será automaticamente rebaixada para uma solicitação regular, e o cliente não receberá uma mensagem de erro.

0

ClientToken

string

Não

Um token de cliente para garantir a idempotência da solicitação. O cliente gera o valor, mas você deve garantir que o valor seja exclusivo entre diferentes solicitações. O token diferencia maiúsculas de minúsculas e pode conter até 64 caracteres ASCII.

6000170000591aed949d0f******************

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

RequestId

string

O ID da solicitação.

F2A9EFA7-915F-4572-8299-85A307******

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F2A9EFA7-915F-4572-8299-85A307******"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 InvalidEndpointConfig.Malformed The specified parameter EndpointConfig is not valid. The specified EndpointConfig parameter is invalid.
400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. The specified DBEndpointId parameter is invalid.
400 InvalidNodes.Malformed The specified parameter Nodes is not valid. The specified Nodes parameter is invalid.
403 OperationDenied.InstanceType The operation is not permitted due to instance type. The operation is not allowed due to the instance type
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
404 EndpointStatus.NotSupport Current endpoint status does not support this operation. This operation is not supported while the node is in the current state.
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.
404 InvalidDBClusterId.NotFound The DBInstanceId 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.