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

API do Edge Cloud: Cria um endereço de link.

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

create

*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-***************
EndpointType	string	Sim	O tipo do endpoint de cluster personalizado. O valor é fixo como Custom.	Custom
Nodes	string	Não	Os nós somente leitura a serem adicionados ao endpoint. Separe vários IDs de nó com vírgulas (,). Por padrão, todos os nós são adicionados.	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. Este é o valor padrão.	ReadOnly
AutoAddNewNodes	string	Não	Especifica se novos nós devem ser adicionados automaticamente a este endpoint. Valores válidos: Enable: Novos nós são adicionados automaticamente a este endpoint. Disable: Novos nós não são adicionados automaticamente a este endpoint. Este é o valor padrão.	Disable
EndpointConfig	string	Não	As configurações avançadas do endpoint do cluster, especificadas no formato JSON. Este parâmetro oferece suporte a configurações para nível de consistência, divisão de transações, descarregamento de leituras do nó primário e pool de conexões. Define a política de balanceamento de carga. O formato é {"LoadBalancePolicy":"policy"}. Valores válidos: 0: Balanceamento de carga baseado em conexões. Este é o valor padrão. 1: Balanceamento de carga baseado em solicitações ativas. Define o nível de consistência. O formato é `{"ConsistLevel":"level"}`. Valores válidos: 0: Consistência eventual. 1: Consistência de sessão. Este é o valor padrão. 2: Consistência global. Define a divisão de transações. O formato é `{"DistributedTransaction":"on/off"}`. Valores válidos: on: Ativa a divisão de transações. Este é o valor padrão. off: Desativa a divisão de transações. Especifica se o nó primário aceita solicitações de leitura. O formato é `{"MasterAcceptReads":"on/off"}`. 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. Este é o valor padrão. Define o pool de conexões. O formato é `{"ConnectionPersist":"type"}`. Valores válidos: off: Desativa o pool de conexões. Este é o valor 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. Define a consulta paralela. O formato é {"MaxParallelDegree":"degree"}. Valores válidos: Um número específico de consultas simultâneas. Exemplo: "MaxParallelDegree":"2". off: Desativa a consulta paralela. Este é o valor padrão. Define o roteamento automático para armazenamento de linhas e armazenamento de colunas. O formato é {"EnableHtapImci":"on/off"}. Valores válidos: on: Ativa o roteamento automático para armazenamento de linhas e armazenamento de colunas. off: Desativa o roteamento automático para armazenamento de linhas e armazenamento de colunas. Este é o valor padrão. Especifica se a proteção contra sobrecarga deve ser ativada. O formato é {"EnableOverloadThrottle":"on/off"}. Valores válidos: on: Ativa a proteção contra sobrecarga. off: Desativa a proteção contra sobrecarga. Este é o valor padrão. Nota Você pode definir 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 somente quando o modo de leitura/gravação do endpoint do cluster para um cluster PolarDB for MySQL estiver definido como ReadWrite (divisão automática de leitura/gravação). Quando o modo de leitura/gravação do endpoint do cluster para um cluster PolarDB for MySQL está definido como ReadOnly, tanto o balanceamento de carga baseado em conexões quanto o balanceamento de carga baseado em solicitações ativas são suportados. Quando o modo de leitura/gravação está definido como ReadWrite (divisão automática de leitura/gravação), apenas o balanceamento de carga baseado em solicitações ativas é suportado. Você pode ativar o roteamento automático para armazenamento de linhas e armazenamento de colunas quando o modo de leitura/gravação do endpoint do cluster para um cluster PolarDB for MySQL estiver definido como ReadWrite (divisão automática de leitura/gravação), ou quando o modo de leitura/gravação estiver definido como ReadOnly e a política de balanceamento de carga estiver definida como balanceamento de carga baseado em solicitações ativas. Apenas o PolarDB for MySQL oferece suporte à definição do nível de consistência como 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 configurar o nível de consistência, a divisão de transações, se o nó primário aceita leituras 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 estiver definido como 0, você não poderá ativar a divisão de transações. Se o nível de consistência estiver definido como 1 ou 2, você poderá ativar a divisão de transações.	{"ConsistLevel": "1","DistributedTransaction": "on"}
ClientToken	string	Não	Um token de cliente usado para garantir a idempotência da solicitação. O cliente gera o valor, que deve ser exclusivo entre diferentes solicitações. O token diferencia maiúsculas de minúsculas e pode ter até 64 caracteres ASCII de comprimento.	6000170000591aed949d0f******************
DBEndpointDescription	string	Não	O nome do endpoint de cluster personalizado.	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.	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: Envia a solicitação para o nó primário. 2: Faz o downgrade para solicitações regulares. 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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	CD35F3-F3-44CA-AFFF-BAF869******

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ClusterEndpoint.StatusNotValid	Cluster endpoint status is not valid.	The state of the cluster endpoint is invalid.
400	EndpointNum.Error	Endpoint number error.	The maximum number of endpoints is exceeded.
400	LockTimeout	The request processing has failed due to lock timeout.	Failed to process the request due to a lock timeout.
403	OperationDenied.InstanceType	The operation is not permitted due to instance type.	The operation is not allowed due to the instance type
404	EndpointConfig.Invalid	Endpoint config is invalid.	The advanced parameter of the cluster endpoint is invalid.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	EndpointConfig.Conflict	Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.	Endpoint the configuration is invalid, the CausalConsistRead should be a session because global consistency (high performance mode) for the node is enabled.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.