ModifyDBProxy - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Habilita o modifica la función de proxy de base de datos para una instancia.

Descripción de la operación

Motores de base de datos compatibles

MySQL
PostgreSQL

Nota

A partir del 17 de octubre de 2023, las instancias de ApsaraDB RDS for MySQL que ejecutan RDS Cluster Edition ofrecen un proxy de base de datos dedicado sin costo adicional por cada unidad, en fases. Para obtener más información, consulte [Ofertas especiales/Cambios de precios] Se proporciona un proxy dedicado sin costo adicional para instancias de ApsaraDB RDS for MySQL en RDS Cluster Edition.

Referencias

Nota

Antes de llamar a esta operación, lea los siguientes temas y asegúrese de comprender completamente los requisitos previos y los impactos de esta operación.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

rds:ModifyDBProxy

update

*DBInstance.

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

rds:ResourceTag
rds:InstanceNetworkType

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-uf6wjk5****
ConfigDBProxyService	string	Sí	Especifica si se debe habilitar o deshabilitar la función de proxy de base de datos. Valores válidos: Startup: habilita la función. Shutdown: deshabilita la función. Modify: modifica la configuración de la función.	Startup
DBProxyInstanceNum	string	No	El número de instancias de proxy habilitadas. Valores válidos: 1 a 16. Valor predeterminado: 1. Nota La capacidad del proxy de base de datos para procesar solicitudes aumenta con el número de instancias de proxy habilitadas. Puede monitorear la carga de la instancia y especificar un número adecuado de instancias de proxy según los datos de monitoreo de carga.	1
RegionId	string	No	El ID de la región. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
InstanceNetworkType	string	No	El tipo de red de la instancia. Solo se admite el tipo de red VPC. Establezca el valor en VPC. Nota Si habilita la función de proxy de base de datos para la instancia, debe especificar este parámetro.	VPC
VPCId	string	No	El ID de la nube privada virtual (VPC) a la que pertenece la instancia. Puede llamar a la operación DescribeDBInstanceAttribute para consultar el ID. Nota Si habilita la función de proxy de base de datos para la instancia, debe especificar este parámetro.	vpc-****
VSwitchId	string	No	El ID del vSwitch al que pertenece la instancia. Puede llamar a la operación DescribeDBInstanceAttribute para consultar el ID. Nota Si habilita la función de proxy de base de datos para la instancia, debe especificar este parámetro.	vsw-****
DBProxyEngineType	string	No	Un parámetro obsoleto. No necesita especificar este parámetro.	normal
DBProxyInstanceType	string	No	El tipo de proxy de base de datos. Valores válidos: common: proxy de base de datos de uso general exclusive (predeterminado): proxy de base de datos dedicado	exclusive
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-uf6wjk5****
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmy****
PersistentConnectionStatus	string	No	Especifica si se deben habilitar las conexiones persistentes. Valores válidos: Enabled Disabled Nota Este parámetro solo está disponible para instancias que ejecutan MySQL. Si desea modificar las conexiones persistentes, debe establecer el parámetro ConfigDBProxyService en Modify.	Disabled
DBProxyNodes	array<object>	No	Los nodos de proxy.
	object	No	Los detalles del nodo de proxy.
cpuCores	string	No	El número de núcleos de CPU del nodo. Valores válidos: 1 a 16. Nota Este parámetro es obligatorio cuando configura el parámetro DBProxyNodes.	1
nodeCounts	string	No	El número de nodos de proxy en la zona. Valores válidos: 1 y 2. Nota Este parámetro es obligatorio cuando configura el parámetro DBProxyNodes.	2
zoneId	string	No	El ID de la zona en la que reside el nodo. Nota Este parámetro es obligatorio cuando configura el parámetro DBProxyNodes.	cn-hangzhou-c

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	FC452BB1-EED8-4278-95C7-0324B3710DF1

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	MaxscaleAlreadyExist	The Maxscale is already existed.
400	MaxscaleNotSupport	Maxscale not supported
400	NetWork.NotFound	NetWork.NotFound
400	InvalidVpcParameter	Either VPC ID or vSwitch ID is incorrect. Please check again.
400	MaxscaleInternalError	Database proxy status is CLASS_CHANGING.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.
400	InvalidOptimizationCategory.Format	Specified optimization category is not valid.
400	MinorVersionNotSupport	The current database minor version does not support the operation.
400	InvalidParameters.Format	Specified parameter is not valid
400	InvalidTunnelId	Specified conn tunnel is not valid.
400	InvalidRegion.Format	Specified Region is not valid.
400	InvalidDBProxyNodes.General	general-purpose proxy does not support more than 2 nodes.
400	InvalidDBProxyNodes.ZoneIdAndNodeCounts	The number of node count and zone count is mismatch.
400	InvalidDBProxyNodes.ZoneId	The number of zone is request 1 or 2.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
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.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
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.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
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.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	InvalidDBProxyNodes.ZoneIdNotUnique	ZoneIds is not unique.
400	MaxscaleServiceLinkedRole.NotFound	Service linked role 'AliyunServiceRoleForRDSProxyOnEcs' not found.
400	MappingInstanceLevel.NotFound	Can not find the mapping instance level.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	InvalidConnVPCId	Specified conn vpc id is not valid.
403	IncorrectDBInstanceType	The database instance type does not support the operation.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.
403	IncorrectKindCode	Current custins kindCode does not support this operation.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	MaxscaleCreating	The relative maxscale instance is being created or deleted.
404	Maxscale.NotFound	The relative maxscale instance is not found.
404	InvalidVSwitchId.NotFound	The specified VSwitch is invalid.
404	InvalidParam	The parameter is invalid.
404	InsufficientResourceCapacity	The target availability zone does not have sufficient resources.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.