CreateDBInstanceEndpoint - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

Cria um endpoint para uma instância ApsaraDB RDS Cluster Edition.

Descrição da operação

Mecanismos compatíveis

ApsaraDB RDS for MySQL

Documentação relacionada

Importante Antes de chamar esta operação, leia a documentação para compreender totalmente os pré-requisitos e os impactos.

Adicionar um endpoint somente leitura de cluster

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

rds:CreateDBInstanceEndpoint

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação e evitar envios duplicados. O valor é gerado pelo cliente e deve ser exclusivo em diferentes solicitações. O valor pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	6000170000591aed949d0f****
DBInstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar o ID da instância.	rm-****
VpcId	string	Sim	O ID da VPC para o endpoint interno.	vpc-xxxmmxjqqi****
VSwitchId	string	Sim	O ID do vSwitch para o endpoint interno.	vsw-bp1kqp****
PrivateIpAddress	string	Não	O endereço IP para o endpoint interno.	172.16.XX.XX
ConnectionStringPrefix	string	Sim	O prefixo do endpoint interno. Ao criar um endpoint, um endpoint interno é criado automaticamente. Este parâmetro especifica o prefixo do endpoint interno.	rm-****-ro
Port	string	Sim	O número da porta para o endpoint interno. Você pode especificar um número de porta personalizado ao criar um endpoint interno. Valores válidos: 3000 a 5999.	3306
DBInstanceEndpointType	string	Sim	O tipo do endpoint. Valores válidos: Primary: o endpoint de leitura e gravação da instância. Readonly: o endpoint somente leitura da instância. Valores válidos: Readonly : Readonly.	Readonly
DBInstanceEndpointDescription	string	Não	A descrição personalizada do endpoint.	for readonly business
NodeItems	array<object>	Sim	A lista de informações de nós do endpoint.
	object	Não	Os detalhes do nó do endpoint.
DBInstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar o ID da instância.	rm-****
NodeId	string	Sim	O ID do nó.	rn-xxxx-****
Weight	integer	Não	O peso atual do nó. O tráfego de leitura é distribuído com base neste valor. Valores válidos: 0 a 100.	50
ResourceGroupId	string	Não	O ID do grupo de recursos. Você pode chamar a operação DescribeDBInstanceAttribute para consultar o ID.	rg-acfmy****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes dos parâmetros de resposta.
Data	object	A lista de dados retornados.
ConnectionString	string	O endpoint interno.	rm-****.mysql.rds.aliyuncs.com
DBInstanceEndpointId	string	O ID do endpoint da instância.	ep-****
DBInstanceName	string	O ID da instância.	rm-****
RequestId	string	O ID da solicitação.	C8E88DED-533F-4B3C-9207-731FBF394CCA

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "ConnectionString": "rm-****.mysql.rds.aliyuncs.com",
    "DBInstanceEndpointId": "ep-****",
    "DBInstanceName": "rm-****"
  },
  "RequestId": "C8E88DED-533F-4B3C-9207-731FBF394CCA"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidSourceCategory	specified source category is invalid.	A categoria de origem especificada é inválida.
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.	O tipo de conexão da instância de banco de dados atual não oferece suporte a esta operação.
400	EndpointNum.Error	The number of endpoint is too many.	O número atual de endpoints não atende aos requisitos. Verifique a quantidade de endpoints com suporte.
400	InvalidNodeItems.DuplicateNodeId	Duplicate nodeId, please ensure all nodeIds are different.	O parâmetro NodeItems contém valores NodeId duplicados.
400	InvalidNodeItems.RONode	ReadOnly endpoint can not contain readonly instance node.	Um endpoint somente leitura não pode conter nós de uma instância somente leitura.
400	InvalidNodeItems.RONodeIdPrimary	ReadOnly endpoint can not contain primary node.	Um endpoint somente leitura não pode conter o nó primário.
400	InvalidNodeItems.JsonFormat	NodeItems is not a json string.	O parâmetro NodeItems deve ser uma string JSON.
400	InvalidNodeItems.DBInstanceId	Specified dbInstanceId is invalid	O dbInstanceId em NodeItems é inválido.
400	InvalidNodeItems.NodeId	Specified Node id is invalid	NodeItems contém um NodeId que não existe no cluster.
400	EndpointType.NotSupport	Current db type is not support specified endpoint type.	O tipo de endpoint especificado não é suportado.
400	OtherEndpoint.Exist	Other endpoint already exist.	O prefixo do endpoint já existe.
400	InvalidPort.Malformed	Specified port is not valid.	A porta especificada é inválida.
400	APICallingFailed	Api called failed, please check vpc vsw vip	Uma chamada interna para a API de backend falhou.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	O ID da instância especificado não existe. Verifique o ID e tente novamente.
400	InvalidNodeItems.BlackNodeItems	NodeItems is blank.	Os dados do nó não podem estar vazios.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Operações individuais não são permitidas para instâncias agrupadas.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	O resultado de preços para o plano de preços não foi encontrado.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	Você não concluiu a verificação de nome real e não atende aos requisitos de compra. Faça login em Despesas e Custos para concluir a verificação de nome real.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	O saldo disponível da sua conta é menor que 0. Recarregue sua conta antes de tentar fazer uma compra.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	A chamada para o serviço de produtos falhou.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	O Alibaba Cloud planeja otimizar e ajustar a região atual, e os serviços em nuvem nesta região cessarão as operações. Para garantir a continuidade dos negócios e uma transição suave para a migração de dados, você não pode realizar novos pedidos de compra no momento. Agradecemos sua compreensão e apoio.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	O módulo especificado é inválido. Adquira um módulo válido.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	A região foi desativada.
400	Price.CommoditySys	Commodity system call exception.	Ocorreu uma exceção ao chamar o sistema de produtos.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	O período de assinatura selecionado é inválido. Selecione novamente o período de assinatura.
400	pay.noCreditCard	Account not bound to credit card.	A conta não está vinculada a um cartão de crédito.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	Você tem pedidos não pagos para o serviço selecionado. Pague ou cancele os pedidos não pagos antes de fazer um novo pedido.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	Nenhum método de pagamento está especificado para a sua conta. Adicione um método de pagamento.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Suas informações estão incompletas. Complete suas informações antes de prosseguir.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Sua conta está em um estado anormal. Entre em contato com o suporte ao cliente para obter detalhes.
400	Api.NotSupport	Specified api is not supported.	A operação de API atual não é suportada.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Uma tag que proíbe a realização de pedidos está presente. Entre em contato com seu distribuidor para obter assistência.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	A instância especificada não existe. Verifique se a instância existe e se não foi excluída.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	O tipo de instância atual não suporta este tipo de armazenamento.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	A operação falhou porque o parâmetro especificado é inválido.
400	KmsApiError	User secret key invalid.	A chave do usuário é inválida.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.	A conta não existe.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	A execução do comando SQL falhou ou atingiu o tempo limite.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	A versão atual do mecanismo de banco de dados da instância não suporta o arquivamento de dados frios.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	A versão atual do kernel não suporta o arquivamento de dados frios.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	O tipo de instância atual não suporta esta operação.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	O nome do endpoint está duplicado. Reconfigure a string de conexão.
400	RequiredParam.NotFound	Required input param is not found.	Os parâmetros obrigatórios não foram fornecidos.
400	Parameters.Invalid	Parameter error, please check the parameters.	O parâmetro especificado é inválido. Verifique os parâmetros.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	O arquivamento de dados não suporta backups entre regiões ou snapshots em segundos. Verifique a política de backup.
400	InvalideStatus.Format	The instance status does not support this operation.	O status atual da instância não oferece suporte a esta operação.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	A política de retenção para backups arquivados após a liberação da instância é inválida.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	Esta operação não é suportada para o tipo de mecanismo de banco de dados da instância.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Esta operação não é suportada para instâncias do tipo VPC.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	A imagem da instância de banco de dados atual já existe.
400	UnsupportedClassCode	The specified DB instance class stops selling.	O tipo de instância não está mais disponível para compra.
400	InvalidBackupSet	The specified database does not exist in the backup set.	O banco de dados especificado não existe no conjunto de backups.
400	OrdTCommodityQueryError	Failed to query for product.	Falha ao consultar o produto.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	A instância foi liberada. Verifique o status da instância antes de fazer um pedido.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	A região foi desativada.
500	ExternalFailure	The request processing has failed due to external service failure.	A solicitação de serviço falhou. Tente novamente mais tarde.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	A solicitação de serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte técnico.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	O processamento da solicitação falhou devido a uma falha no serviço da API do RDS.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	A operação falhou. O status atual da instância não suporta esta operação. Tente novamente mais tarde.
403	InvalidConnVPCId	Specified conn vpc id is not valid.	O ID da VPC especificado para a conexão é inválido.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	O VSwitchId especificado é inválido ou está vazio.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	A instância possui pedidos não pagos. Pague os pedidos e tente novamente.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	A capacidade de destino para redução de escala não pode ser menor que o uso de armazenamento atual.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Esta operação não é suportada para SSDs padrão. Faça upgrade para ESSDs.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Você não tem as permissões necessárias para realizar esta operação.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	A versão secundária atual do mecanismo não suporta esta operação.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Nenhuma zona com estoque disponível foi encontrada.
403	NotInFlowController	Sorry,no permission.	Este recurso não está disponível para usuários de nuvem que não pertencem a um grupo. Você não tem as permissões necessárias.
403	InvalidKmsKey	Kms key is disabled.	A chave KMS especificada está desativada.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	A operação falhou porque o código de especificação especificado não suporta o número de endpoints. Verifique o número de shards e o número atual de endpoints.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	A operação falhou porque a instância está bloqueada.
404	InvalidConnectionString.NotFound	Specified connection string or net type is not found.	A string de conexão não existe. Verifique se a string de conexão está correta.
404	InvalidConnectionString.Duplicate	Specified connection string already exists in the Aliyun RDS.	O nome do endpoint está duplicado. Reconfigure a string de conexão.
404	InvalidWeight.Format	The Specified Weight format is not valid.	O intervalo de peso especificado é inválido.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	A instância especificada não existe ou não oferece suporte a esta operação.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	A instância atual não está autorizada a acessar o Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	O recurso solicitado não está disponível.
404	HostInfo.NotFound	The specified host info is not found.	As informações do host especificado não existem.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.