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

Cria um endpoint de cluster personalizado para 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:CreateDBClusterEndpoint

create

*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.	pc-**************
EndpointType	string	Sim	O tipo do endpoint de cluster personalizado. Valores válidos: Custom: endpoint de cluster personalizado. DynamoDB: endpoint DynamoDB.	Custom
Nodes	string	Não	Os nós de leitura a serem adicionados ao endpoint. Separe múltiplos nós com vírgulas (,). Por padrão, todos os nós são adicionados. Nota Para PolarDB for MySQL, especifique IDs de nós. Para PolarDB for PostgreSQL e PolarDB for PostgreSQL (Compatible with Oracle), especifique nomes de função de nó, como `Writer,Reader1,Reader2`. Se ReadWriteMode estiver definido como ReadOnly, você pode montar apenas um nó. No entanto, se esse nó falhar, o endpoint pode ficar indisponível por até 1 hora. Não use essa configuração em ambientes de produção. Selecione pelo menos 2 nós para melhorar a disponibilidade. Se ReadWriteMode estiver definido como ReadWrite, selecione pelo menos 2 nós. * Para PolarDB for MySQL, você pode selecionar quaisquer dois nós. Se ambos os nós forem nós somente leitura, as solicitações de escrita serão encaminhadas para o nó primário. * Para PolarDB for PostgreSQL e PolarDB for PostgreSQL (Compatible with Oracle), o nó primário deve ser incluído.	pi-********,pi-*******
ReadWriteMode	string	Não	O modo de leitura/escrita. Valores válidos: ReadWrite: leitura/escrita (divisão automática de leitura/escrita). ReadOnly (padrão): somente leitura.	ReadOnly
AutoAddNewNodes	string	Não	Especifica se novos nós são adicionados automaticamente a este endpoint. Valores válidos: Enable: novos nós são adicionados automaticamente a este endpoint. Disable (padrão): novos nós não são adicionados automaticamente a este endpoint.	Disable
EndpointConfig	string	Não	As configurações avançadas do endpoint de cluster em formato JSON. Você pode configurar o nível de consistência, divisão de transações, descarregamento de leituras do nó primário e configurações de pool de conexões. Política de balanceamento de carga. Formato: {"LoadBalancePolicy":"Política de balanceamento de carga"}. Valores válidos: 0: balanceamento de carga baseado em conexão (padrão). 1: balanceamento de carga baseado em solicitações ativas. Nível de consistência. Formato: `{"ConsistLevel":"Nível de consistência"}`. Valores válidos: 0: consistência eventual. 1: consistência de sessão (padrão). 2: consistência global. Divisão de transações. Formato: `{"DistributedTransaction":"Divisão de transações"}`. Valores válidos: on: ativa a divisão de transações (padrão). off: desativa a divisão de transações. Descarregamento de leituras do nó primário. Formato: `{"MasterAcceptReads":"Descarregamento de leituras do nó primário"}`. 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 (padrão). Pool de conexões. Formato: `{"ConnectionPersist":"Pool de conexões"}`. Valores válidos: off: desativa o pool de conexões (padrão). Session: ativa o pool de conexões em nível de sessão. Transaction: ativa o pool de conexões em nível de transação. Consulta paralela. Formato: {"MaxParallelDegree":"Consulta paralela"}. Valores válidos: Um grau específico de paralelismo. Exemplo: "MaxParallelDegree":"2". off: desativa a consulta paralela (padrão). Distribuição automática de solicitações entre nós de armazenamento em linha e em coluna. Formato: {"EnableHtapImci":"Distribuição automática de solicitações entre nós de armazenamento em linha e em coluna"}. Valores válidos: on: ativa a distribuição automática de solicitações entre nós de armazenamento em linha e em coluna. off: desativa a distribuição automática de solicitações entre nós de armazenamento em linha e em coluna (padrão). Proteção contra sobrecarga. Formato: {"EnableOverloadThrottle":"Proteção contra sobrecarga"}. Valores válidos: on: ativa a proteção contra sobrecarga. off: desativa a proteção contra sobrecarga (padrão). Nota Divisão de transações, descarregamento de leituras do nó primário, pool de conexões e proteção contra sobrecarga podem ser configurados apenas quando o modo de leitura/escrita do endpoint de cluster do PolarDB for MySQL for ReadWrite (divisão automática de leitura/escrita). Quando o modo de leitura/escrita do endpoint de cluster do PolarDB for MySQL for ReadOnly, tanto o balanceamento de carga baseado em conexão quanto o balanceamento de carga baseado em solicitações ativas são suportados. O modo ReadWrite (divisão automática de leitura/escrita) suporta apenas o balanceamento de carga baseado em solicitações ativas. A distribuição automática de solicitações entre nós de armazenamento em linha e em coluna pode ser configurada quando o modo de leitura/escrita do endpoint de cluster do PolarDB for MySQL for ReadWrite (divisão automática de leitura/escrita), ou quando o modo de leitura/escrita for ReadOnly e a política de balanceamento de carga for balanceamento de carga baseado em solicitações ativas. Apenas o PolarDB for MySQL suporta a definição do nível de consistência como consistência global. Se ReadWriteMode estiver definido como ReadOnly, o nível de consistência só pode ser definido como 0. Você pode configurar o nível de consistência, divisão de transações, descarregamento de leituras do nó primário e pool de conexões ao mesmo tempo. Exemplo: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`. A divisão de transações é restrita pelo nível de consistência. Por exemplo, a divisão de transações não pode ser ativada quando o nível de consistência é 0. A divisão de transações pode ser ativada quando o nível de consistência é 1 ou 2.	{"ConsistLevel": "1","DistributedTransaction": "on"}
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação e evitar envios repetidos. O token é gerado pelo cliente, deve ser único entre as solicitações, diferencia maiúsculas de minúsculas e não pode exceder 64 caracteres ASCII.	6000170000591aed949d0f******************
DBEndpointDescription	string	Não	O nome do endpoint de cluster personalizado.	test
VPCId	string	Não	O ID da VPC.	vpc-2zehr7ghqovftils0****
VSwitchId	string	Não	O ID do vSwitch.	vsw-2ze775gnf7jn33ua****
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: ativado. OFF: desativado.	on
PolarSccWaitTimeout	string	Não	O período de timeout para consistência global.	100
PolarSccTimeoutAction	string	Não	A política de timeout para consistência global. Valores válidos: 0: envia a solicitação para o nó primário. 2: degradação por timeout. Após o timeout de uma leitura de consistência global, a consulta é automaticamente degradada para solicitações regulares, e o cliente não recebe uma mensagem de erro.	0
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.	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.	O status do endpoint do cluster é inválido.
400	EndpointNum.Error	Endpoint number error.	O número de endpoints excede o limite.
400	LockTimeout	The request processing has failed due to lock timeout.	A solicitação falhou ao ser processada devido a um timeout de bloqueio.
403	OperationDenied.InstanceType	The operation is not permitted due to instance type.	A operação não é permitida devido ao tipo de instância.
404	EndpointConfig.Invalid	Endpoint config is invalid.	Os parâmetros de configuração avançada do endpoint do cluster são inválidos.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	O DBClusterId especificado não existe nos registros atuais.
404	EndpointConfig.Conflict	Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.	A configuração do endpoint é inválida. CausalConsistRead deve ser definido como session porque a consistência global (modo de alto desempenho) está ativada para o nó.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.