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

Ativa ou modifica o recurso de instância de proxy de banco de dados para uma instância do ApsaraDB RDS.

Descrição da operação

Mecanismos compatíveis

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL

Nota

A partir de 17 de outubro de 2023, o ApsaraDB RDS for MySQL Cluster Edition fornece gradualmente um serviço de proxy dedicado gratuito com uma instância de proxy em todas as unidades. Para obter detalhes, consulte Promoção: o ApsaraDB RDS for MySQL Cluster Edition fornece um serviço de proxy dedicado gratuito com uma instância de proxy.

Documentação do recurso relacionado

Importante Antes de usar esta operação, leia atentamente a documentação do recurso para garantir que você compreenda totalmente os pré-requisitos e os impactos da operação.

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

update

*DBInstance

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

rds:ResourceTag
rds:InstanceNetworkType

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar o ID da instância.	rm-uf6wjk5****
ConfigDBProxyService	string	Sim	Especifica se o proxy de banco de dados deve ser ativado ou desativado. Valores válidos: Startup: Ativa o serviço de proxy. Shutdown: Desativa o serviço de proxy. Modify: Modifica o serviço de proxy.	Startup
DBProxyInstanceNum	string	Não	O número de instâncias de proxy a serem ativadas. Valores válidos: 1 a 16. Valor padrão: 1. Nota Mais instâncias de proxy podem processar mais solicitações. Você pode verificar a carga das instâncias de proxy com base nos dados de monitoramento e especificar um número apropriado de instâncias de proxy.	1
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
InstanceNetworkType	string	Não	O tipo de rede da instância. Apenas VPC é compatível. Valor válido: VPC. Nota Este parâmetro é obrigatório quando você ativa o proxy de banco de dados.	VPC
VPCId	string	Não	O ID da VPC à qual a instância pertence. Você pode chamar a operação DescribeDBInstanceAttribute para consultar o ID da VPC. Nota Este parâmetro é obrigatório quando você ativa o proxy de banco de dados.	vpc-****
VSwitchId	string	Não	O ID do vSwitch ao qual a instância pertence. Você pode chamar a operação DescribeDBInstanceAttribute para consultar o ID do vSwitch. Nota Este parâmetro é obrigatório quando você ativa o proxy de banco de dados.	vsw-****
DBProxyEngineType	string	Não	[Deprecated] Este parâmetro foi descontinuado e não precisa ser configurado.	normal
DBProxyInstanceType	string	Não	O tipo da instância de proxy de banco de dados. Valores válidos: common: Proxy de banco de dados de uso geral. exclusive: Proxy dedicado (padrão).	exclusive
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmy****
PersistentConnectionStatus	string	Não	Especifica se o keep-alive de conexão deve ser ativado. Valores válidos: Enabled: Ativa o keep-alive de conexão. Disabled: Desativa o keep-alive de conexão. Nota Apenas o ApsaraDB RDS for MySQL é compatível com este parâmetro. Ao modificar o status de keep-alive da conexão, defina ConfigDBProxyService como Modify.	Disabled
DBProxyNodes	array<object>	Não	A lista de nós de proxy.
	object	Não	Os detalhes do nó de proxy.
cpuCores	string	Não	O número de núcleos de CPU para o nó. Valores válidos: 1 a 16. Nota Este parâmetro é obrigatório quando você especifica DBProxyNodes.	1
nodeCounts	string	Não	O número de nós de proxy na zona. Valores válidos: 1 a 2. Nota Este parâmetro é obrigatório quando você especifica DBProxyNodes.	2
zoneId	string	Não	O ID da zona do nó. Nota Este parâmetro é obrigatório quando você especifica DBProxyNodes.	cn-hangzhou-c

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	FC452BB1-EED8-4278-95C7-0324B3710DF1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MaxscaleAlreadyExist	The Maxscale is already existed.	O MaxScale já existe.
400	MaxscaleNotSupport	Maxscale not supported	A operação falhou porque a instância não oferece suporte ao proxy dedicado. Verifique a configuração para ativar o proxy dedicado.
400	NetWork.NotFound	NetWork.NotFound	A rede está indisponível.
400	InvalidVpcParameter	Either VPC ID or vSwitch ID is incorrect. Please check again.	O ID da VPC e o ID do vSwitch são inválidos. Verifique se o ID da VPC e o ID do vSwitch estão corretos.
400	MaxscaleInternalError	Database proxy status is CLASS_CHANGING.	O proxy do banco de dados está passando por uma alteração de especificação. Reinicie-o mais tarde.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	O nome da instância especificado (DBInstanceName) é inválido. Verifique se o valor do parâmetro é nulo ou uma string vazia.
400	InvalidOptimizationCategory.Format	Specified optimization category is not valid.	O parâmetro OptimizationCategory é inválido.
400	MinorVersionNotSupport	The current database minor version does not support the operation.	A versão secundária atual do mecanismo da instância não oferece suporte a esta operação. Atualize a versão secundária do mecanismo.
400	InvalidParameters.Format	Specified parameter is not valid	O parâmetro é inválido.
400	InvalidTunnelId	Specified conn tunnel is not valid.	O canal de conexão especificado é inválido.
400	InvalidRegion.Format	Specified Region is not valid.	A região especificada é inválida. Verifique se o parâmetro da região está correto.
400	InvalidDBProxyNodes.General	general-purpose proxy does not support more than 2 nodes.	O proxy de banco de dados de uso geral não oferece suporte a mais de dois nós.
400	InvalidDBProxyNodes.ZoneIdAndNodeCounts	The number of node count and zone count is mismatch.	O número de zonas ou nós é inválido.
400	InvalidDBProxyNodes.ZoneId	The number of zone is request 1 or 2.	O campo ZoneId em DBProxyNodes deve especificar exatamente uma ou duas zonas.
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.
400	InvalidDBProxyNodes.ZoneIdNotUnique	ZoneIds is not unique.	O ID da zona não é único.
400	MaxscaleServiceLinkedRole.NotFound	Service linked role 'AliyunServiceRoleForRDSProxyOnEcs' not found.	A função vinculada ao serviço para o proxy de banco de dados não foi encontrada. Verifique a configuração.
400	MappingInstanceLevel.NotFound	Can not find the mapping instance level.	O tipo de instância mapeado não foi encontrado.
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	InvalidConnVPCId	Specified conn vpc id is not valid.	O ID da VPC especificado para a conexão é inválido.
403	IncorrectDBInstanceType	The database instance type does not support the operation.	A operação falhou porque o mecanismo e o tipo da instância de banco de dados atual não são suportados.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	A operação falhou porque o mecanismo de banco de dados atual não é suportado.
403	IncorrectKindCode	Current custins kindCode does not support this operation.	A operação falhou porque o tipo de ambiente da instância atual não é suportado. Verifique os tipos de instância suportados pela operação de API.
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	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	MaxscaleCreating	The relative maxscale instance is being created or deleted.
404	Maxscale.NotFound	The relative maxscale instance is not found.	A operação falhou porque nenhuma instância MaxScale associada foi encontrada.
404	InvalidVSwitchId.NotFound	The specified VSwitch is invalid.
404	InvalidParam	The parameter is invalid.	A operação falhou porque o parâmetro especificado é inválido.
404	InsufficientResourceCapacity	The target availability zone does not have sufficient resources.	Os recursos no cluster atual são insuficientes. Tente novamente mais tarde.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	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.