ModifyDBProxyInstance - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Modifie la configuration d'un proxy de base de données pour une instance.

Description de l'opération

Moteurs de base de données pris en charge

MySQL
PostgreSQL

Remarque

À partir du 17 octobre 2023, les instances ApsaraDB RDS for MySQL exécutant l'édition RDS Cluster offrent progressivement un proxy de base de données dédié gratuit pour chaque unité. Pour plus d'informations, consultez [Offres spéciales/Modifications de prix] Un proxy dédié est fourni gratuitement pour les instances ApsaraDB RDS for MySQL sur l'édition RDS Cluster.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

rds:ModifyDBProxyInstance

update

*DBInstance

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

rds:ResourceTag
rds:ResourceTag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-t4n3a****
DBProxyInstanceType	string	Oui	Le type de proxy de base de données. Valeurs valides : common : proxy de base de données à usage général exclusive (par défaut) : proxy de base de données dédié	exclusive
DBProxyInstanceNum	string	Oui	Le nombre de proxys de base de données. Si vous définissez ce paramètre sur 0, la fonctionnalité de proxy de base de données est désactivée pour l'instance. Valeurs valides : 1 à 16. Remarque La capacité de la fonctionnalité de proxy de base de données à traiter les requêtes augmente avec le nombre de proxys activés. Vous pouvez surveiller la charge de l'instance et spécifier un nombre approprié de proxys en fonction des données de surveillance de la charge.	2
EffectiveTime	string	Non	L'heure de prise d'effet. Valeurs valides : Immediate : La prise d'effet est immédiate. MaintainTime : La prise d'effet a lieu pendant la fenêtre de maintenance. Pour plus d'informations, consultez ModifyDBInstanceMaintainTime. SpecificTime : La prise d'effet a lieu à un moment spécifié. Valeur par défaut : MaintainTime.	MaintainTime
EffectiveSpecificTime	string	Non	Le moment que vous souhaitez spécifier. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Remarque Si le paramètre EffectiveTime est défini sur SpecificTime, vous devez spécifier ce paramètre.	2019-07-10T13:15:12Z
RegionId	string	Non	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-t4n3a****
DBProxyEngineType	string	Non	Un paramètre obsolète. Vous n'avez pas besoin de spécifier ce paramètre.	normal
VSwitchIds	string	Non	L'identifiant du vSwitch dans la zone de destination. Vous pouvez appeler l'opération DescribeVSwitches pour interroger les vSwitches existants. Remarque Seuls les proxys de base de données des instances ApsaraDB RDS for MySQL utilisant des disques cloud peuvent être migrés vers différentes zones.	vsw-uf6adz52c2p****
DBProxyNodes	array<object>	Non	Liste des nœuds de proxy. Remarque Ce paramètre doit être renseigné lorsque l'instance de proxy actuelle est déployée dans plusieurs zones de disponibilité.
	object	Non
cpuCores	string	Non	Le nombre de cœurs de processeur du nœud, valeurs valides : 1 à 16.\n>Ce paramètre est requis lors de la sélection de DBProxyNodes.	1
nodeCounts	string	Non	Le nombre de nœuds de proxy dans la zone de disponibilité, valeurs valides : 1 à 16.\n>Ce paramètre est requis lors de la sélection de DBProxyNodes.	2
zoneId	string	Non	L'identifiant de la zone de disponibilité où se trouve le nœud. Remarque Ce paramètre est obligatoire lors de la sélection de DBProxyNodes.	cn-hangzhou-c
MigrateAZ	array<object>	Non	La liste des zones disponibles pour les agents de migration. Remarque Actuellement, seule la migration des instances d'agent de la version sur disque cloud de RDS MySQL est prise en charge.
	object	Non
dbProxyEndpointId	string	Non	L'identifiant de l'adresse de connexion du proxy. Vous pouvez l'obtenir via l'interface DescribeDBProxyEndpoint. Remarque Ce paramètre est requis lorsque MigrateAZ est sélectionné.	yhw429********
destVSwitchId	string	Non	L'identifiant du VSwitch cible correspondant à la migration de l'instance proxy. Remarque Ce paramètre est requis lorsque MigrateAZ est sélectionné.	vsw-sw0qq49d1m****
destVpcId	string	Non	L'identifiant du VPC cible correspondant à la migration de l'instance de proxy.	vpc-2vcicu73rdylp****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	65C55572-530E-4A53-BE03-1D08CAF0F046

Exemples

JSON format

{
  "RequestId": "65C55572-530E-4A53-BE03-1D08CAF0F046"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.
400	InvalidParameters.Format	Specified parameter is not valid	The operation failed. The values of some parameters are invalid.
400	InvalidAvZone.Format	Specified AvZone is not valid.	The value of the AvZone parameter is invalid. Check the value of this parameter.
400	ErrorMxsServiceInsNum.Error	The Maxscale serviceIns num must be 1.
400	TaskExists	Specified task have existed.	The task already exists.
400	InvalidVSwitchIds	Specified vSwitchId is invalid.	The specified vSwitchId is invalid.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	APICallingFailed	Api calling failed.	An internal error occurred.
400	InvalidDBProxyNodes.AzProximity	current proxy is open az proximity and target proxy not support az proximity.	current proxy is open az proximity and target proxy not support az proximity.
400	InvalidDBProxyNodes.General	general-purpose proxy does not support more than 2 nodes.	Generic proxy does not support more than 2 nodes.
400	InvalidTargetAvailabilityZone	All endpoint vswitchId must be in the target availability zone.	The vswitchId of all connection addresses must be in the target Availability Zone.
400	InvalidDBProxyNodes.Node	must set DBProxyNodes params with more than 2 proxy nodes.	must set DBProxyNodes params with more than 2 proxy nodes.
400	InvalidDBProxyNodes.ZoneIdAndNodeCounts	The number of node count and zone count is mismatch.	The number of zones or nodes is invalid.
400	InvalidDBProxyNodes.ZoneId	The number of zone is request 1 or 2.	The ZoneId of the DBProxyNodes field can only be one or two zones.
400	InvalidMigrateAZInfo	Invalid MigrateAZ params.	The MigrateAZ parameter is invalid.
400	InvalidDBProxyNodes.ZoneIdNotUnique	ZoneIds is not unique.	The Availability Zone ID is not unique.
400	InvalidVSwitchId.Format	The specified vswitch Id format is incorrect.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	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.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
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.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.	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.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	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.	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.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	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.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
400	MappingInstanceLevel.NotFound	Can not find the mapping instance level.	The mapping instance specification was not found.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	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.	The request failed to be processed due to an RDS API failure.
403	DBInstanceStatusNotActive	Current DB instance status should be active.	The operation failed. Check the status of the RDS instance.
403	InvalidInstanceLevel.Malformed	The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.	The operation failed. The number of proxy terminals that you configure is not supported for the instance type. Check the number of data shards and the number of proxy terminals.
403	NotHaveProxy	The current instance does not have a proxy.
403	MaxscaleMinorVersionNotSupport	The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.	The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.
403	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.	The operation failed. The operation is not supported for the database engine of the RDS instance.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403	IncorrectKindCode	Current custins kindCode does not support this operation.	The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403	IncorrectDBType	The current DB type does not support this operation.	The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectDBInstance	The current DB instance does not support this operation.	The operation failed. The operation is not supported for the RDS instance.
403	MaxscaleInstanceNotSupport	Instances with maxscale instance do not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.	The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.
404	InsufficientResourceCapacity	The target availability zone does not have sufficient resources.	The target Availability Zone does not have enough resources.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.