Todos os produtos
Search

Este produto

    PolarDB:ModifyDBClusterEndpoint

    Central de documentação

    PolarDB:ModifyDBClusterEndpoint

    Última atualização: Jun 28, 2026

    Modifica as propriedades de um endpoint do cluster PolarDB. Você pode configurar definições como o modo de leitura/gravação, adição automática de nós, nível de consistência, divisão de transações, o pool de conexões e se o nó primário aceita solicitações de leitura.

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

    update

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 Nenhuma Nenhuma

    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 a serem adicionados ao endpoint para distribuição de solicitações de leitura. Separe vários IDs de nós com vírgulas (,). Os nós originais são usados por padrão.

    Nota

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

    • Para o PolarDB for PostgreSQL e PolarDB for PostgreSQL (Oracle Compatible), especifique as 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 (Oracle Compatible), você deve incluir o nó primário.

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

    string

    Não

    O modo de leitura/gravação. Valores válidos:

    • ReadWrite: Leitura/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 ao endpoint. Valores válidos:

    • Enable: Adiciona novos nós automaticamente.

    • Disable: Não adiciona novos nós automaticamente. Este é o valor padrão.

    Enable
    EndpointConfig

    string

    Não

    As configurações avançadas do endpoint do cluster 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 outras configurações.

    • Define a política de balanceamento de carga. Formato: {"LoadBalancePolicy":"policy"}. Valores válidos:

      • 0: Balanceamento de carga baseado em conexões (padrão)

      • 1: Balanceamento de carga baseado em solicitações ativas

    • Especifica se o nó primário aceita solicitações de leitura. 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.

    • Ativa ou desativa a divisão de transações. Formato: {"DistributedTransaction":"value"}. Valores válidos:

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

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

    • Define o nível de consistência. 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)

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

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

    • Define a política para lidar com tempos limite de leituras de consistência global ou de sessão. Formato: {"ConsistTimeoutAction":"policy"}. Valores válidos:

      • 0: Encaminha solicitações de leitura para o nó primário (padrão).

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

    • Define o tipo de pool de conexões. Formato: {"ConnectionPersist":"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.

    • Ativa ou desativa a consulta paralela. Formato: {"MaxParallelDegree":"value"}. Valores válidos:

      • on: Ativa a consulta paralela.

      • off: Desativa a consulta paralela (padrão).

    • Ativa ou desativa o roteamento automático de solicitações para o armazenamento de linhas ou armazenamento de colunas. Formato: {"EnableHtapImci":"value"}. Valores válidos:

      • on: Ativa o roteamento automático.

      • off: Desativa o roteamento automático (padrão).

    • Ativa ou desativa a proteção contra sobrecarga. 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 definir a divisão de transações, se o nó primário aceita solicitações de leitura, o pool de conexões e 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 baseado em conexões e baseado em solicitações ativas serã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 baseado em solicitações ativas será suportada.

    • Você pode ativar o roteamento automático para o armazenamento de linhas ou armazenamento de colunas se 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 se o modo de leitura/gravação for ReadOnly e a política de balanceamento de carga for baseada em solicitações ativas.

    • Apenas o PolarDB for MySQL suporta consistência global.

    • Se você definir o parâmetro 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, você não pode ativar a divisão de transações se o nível de consistência for 0 (consistência eventual). Você pode ativar a divisão de transações se o nível de consistência for 1 (consistência de sessão) ou 2 (consistência global).

    {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "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

    • OFF: Desativa

    on
    PolarSccWaitTimeout

    string

    Não

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

    100
    PolarSccTimeoutAction

    string

    Não

    A política para lidar com tempos limite de consistência global. Valores válidos:

    • 0: Encaminha 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 regular. O cliente não recebe uma mensagem de erro.

    0

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

    CD3FA5F3-FAF3-44CA-AFFF-BAF869******

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******"
}

    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.