ModifyDBProxy - - Alibaba Cloud Dokümantasyon Merkezi

Bir örnek için veritabanı proxy özelliğini etkinleştirir veya değiştirir.

Operation description

Desteklenen veritabanı motorları

MySQL
PostgreSQL

Not

17 Ekim 2023 tarihinden itibaren, RDS Cluster Edition çalıştıran ApsaraDB RDS for MySQL örnekleri, aşamalı olarak her birim için ücretsiz bir özel veritabanı proxy'si sunmaktadır. Daha fazla bilgi için bkz. [Özel teklifler/Fiyat değişiklikleri] RDS Cluster Edition üzerindeki ApsaraDB RDS for MySQL örnekleri için ücretsiz olarak bir özel proxy sağlanır.

Referanslar

Not

Bu işlemi çağırmadan önce aşağıdaki konuları okuyun ve bu işlemin ön koşullarını ve etkilerini tam olarak anladığınızdan emin olun.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:ModifyDBProxy

update

*DBInstance.

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

rds:ResourceTag
rds:InstanceNetworkType

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.	rm-uf6wjk5****
ConfigDBProxyService	string	Yes	Veritabanı proxy özelliğinin etkinleştirilip etkinleştirilmeyeceğini veya devre dışı bırakılıp bırakılmayacağını belirtir. Geçerli değerler: Startup: Özelliği etkinleştirir. Shutdown: Özelliği devre dışı bırakır. Modify: Özelliğin yapılandırmasını değiştirir.	Startup
DBProxyInstanceNum	string	No	Etkinleştirilen proxy örneklerinin sayısı. Geçerli değerler: 1 ile 16 arası. Varsayılan değer: 1. Not Veritabanı proxy'sinin istekleri işleme kapasitesi, etkinleştirilen proxy örneklerinin sayısıyla artar. Örnek üzerindeki yükü izleyebilir ve yük izleme verilerine dayalı olarak uygun sayıda proxy örneği belirtebilirsiniz.	1
RegionId	string	No	Bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.	cn-hangzhou
InstanceNetworkType	string	No	Örneğin ağ türü. Yalnızca VPC ağ türü desteklenir. Değeri VPC olarak ayarlayın. Not Örnek için veritabanı proxy özelliğini etkinleştirirseniz bu parametreyi belirtmeniz gerekir.	VPC
VPCId	string	No	Örneğin ait olduğu sanal özel bulutun (VPC) kimliği. Kimliği sorgulamak için DescribeDBInstanceAttribute işlemini çağırabilirsiniz. Not Örnek için veritabanı proxy özelliğini etkinleştirirseniz bu parametreyi belirtmeniz gerekir.	vpc-****
VSwitchId	string	No	Örneğin ait olduğu vSwitch'in kimliği. Kimliği sorgulamak için DescribeDBInstanceAttribute işlemini çağırabilirsiniz. Not Örnek için veritabanı proxy özelliğini etkinleştirirseniz bu parametreyi belirtmeniz gerekir.	vsw-****
DBProxyEngineType	string	No	Kullanımdan kaldırılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur.	normal
DBProxyInstanceType	string	No	Veritabanı proxy türü. Geçerli değerler: common: genel amaçlı veritabanı proxy'si exclusive (varsayılan): özel veritabanı proxy'si	exclusive
DBInstanceId	string	Yes	Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.	rm-uf6wjk5****
ResourceGroupId	string	No	Kaynak grubu kimliği.	rg-acfmy****
PersistentConnectionStatus	string	No	Kalıcı bağlantıların etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler: Enabled Disabled Not Bu parametre yalnızca MySQL çalıştıran örnekler için kullanılabilir. Kalıcı bağlantıları değiştirmek istiyorsanız, ConfigDBProxyService parametresini Modify olarak ayarlamanız gerekir.	Disabled
DBProxyNodes	array<object>	No	Proxy düğümleri.
	object	No	Proxy düğümünün ayrıntıları.
cpuCores	string	No	Düğümün CPU çekirdeği sayısı. Geçerli değerler: 1 ile 16 arası. Not DBProxyNodes parametresini yapılandırırken bu parametre gereklidir.	1
nodeCounts	string	No	Bölgedeki proxy düğümlerinin sayısı. Geçerli değerler: 1 ve 2. Not DBProxyNodes parametresini yapılandırırken bu parametre gereklidir.	2
zoneId	string	No	Düğümün bulunduğu bölgenin kimliği. Not DBProxyNodes parametresini yapılandırırken bu parametre gereklidir.	cn-hangzhou-c

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
RequestId	string	İsteğin kimliği.	FC452BB1-EED8-4278-95C7-0324B3710DF1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.