ModifyDBProxyInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

Operasi ini digunakan untuk mengubah konfigurasi instance proxy database ApsaraDB RDS.

Deskripsi operasi

Engine yang didukung

RDS MySQL
RDS PostgreSQL

Catatan

Mulai 17 Oktober 2023, ApsaraDB RDS MySQL Cluster Edition secara bertahap menawarkan layanan proxy database khusus gratis dengan satu instance proxy di setiap unit. Untuk informasi lebih lanjut, lihat [Penawaran] ApsaraDB RDS MySQL Cluster Edition menawarkan layanan proxy database khusus gratis dengan satu instance proxy.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:ModifyDBProxyInstance

update

*DBInstance

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

rds:ResourceTag
rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instance. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instance.	rm-t4n3a****
DBProxyInstanceType	string	Yes	Tipe instance proxy database. Nilai yang valid: common: proxy serbaguna. exclusive: proxy khusus (default).	exclusive
DBProxyInstanceNum	string	Yes	Jumlah instance proxy. Jika Anda mengatur parameter ini ke 0, layanan proxy tipe ini akan dinonaktifkan untuk instance. Nilai yang valid: 1 sampai 16. Catatan Lebih banyak instance proxy dapat menangani lebih banyak permintaan. Anda dapat menentukan beban instance proxy berdasarkan data pemantauan dan mengatur jumlah instance proxy yang sesuai.	2
EffectiveTime	string	No	Waktu kapan perubahan berlaku. Nilai yang valid: Immediate: Perubahan langsung berlaku. MaintainTime: Perubahan berlaku selama jendela pemeliharaan. Untuk informasi lebih lanjut, lihat ModifyDBInstanceMaintainTime. SpecificTime: Perubahan berlaku pada waktu yang ditentukan. Nilai default: MaintainTime.	MaintainTime
EffectiveSpecificTime	string	No	Waktu kapan perubahan berlaku. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Catatan Parameter ini diperlukan ketika EffectiveTime diatur ke SpecificTime.	2019-07-10T13:15:12Z
RegionId	string	No	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
DBInstanceId	string	Yes	ID instance. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instance.	rm-t4n3a****
DBProxyEngineType	string	No	Parameter ini sudah usang dan tidak perlu dikonfigurasi.	normal
VSwitchIds	string	No	Parameter ini sudah usang dan tidak perlu dikonfigurasi.	vsw-uf6adz52c2p****
DBProxyNodes	array<object>	No	Daftar node proxy. Catatan Parameter ini diperlukan ketika instance proxy saat ini di-deploy di beberapa zona.
	object	No	Detail node proxy.
cpuCores	string	No	Jumlah inti CPU dari node. Nilai yang valid: 1 sampai 16. Catatan Parameter ini diperlukan ketika Anda memilih DBProxyNodes.	1
nodeCounts	string	No	Jumlah node proxy di zona. Nilai yang valid: 1 sampai 2. Catatan Parameter ini diperlukan ketika Anda memilih DBProxyNodes.	2
zoneId	string	No	ID zona tempat node berada. Catatan Parameter ini diperlukan ketika Anda memilih DBProxyNodes.	cn-hangzhou-c
MigrateAZ	array<object>	No	Daftar zona tempat proxy dimigrasikan. Catatan Hanya instance RDS MySQL dengan cloud disk yang mendukung migrasi instance proxy antar zona.
	object	No	Detail zona tempat proxy dimigrasikan.
dbProxyEndpointId	string	No	ID endpoint proxy. Anda dapat memanggil operasi DescribeDBProxyEndpoint untuk mengkueri ID. Catatan Parameter ini diperlukan ketika Anda memilih MigrateAZ.	yhw429********
destVSwitchId	string	No	ID vSwitch tujuan tempat instance proxy dimigrasikan. Catatan Parameter ini diperlukan ketika Anda memilih MigrateAZ.	vsw-sw0qq49d1m****
destVpcId	string	No	ID VPC tujuan tempat instance proxy dimigrasikan. Catatan Parameter ini diperlukan ketika Anda memilih MigrateAZ.	vpc-2vcicu73rdylp****

Elemen respons

Element	Type	Description	Example
	object	Detail parameter respons.
RequestId	string	ID permintaan.	65C55572-530E-4A53-BE03-1D08CAF0F046

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.
400	InvalidParameters.Format	Specified parameter is not valid
400	InvalidAvZone.Format	Specified AvZone is not valid.
400	ErrorMxsServiceInsNum.Error	The Maxscale serviceIns num must be 1.
400	TaskExists	Specified task have existed.
400	InvalidVSwitchIds	Specified vSwitchId is invalid.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	APICallingFailed	Api calling failed.
400	InvalidDBProxyNodes.AzProximity	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.
400	InvalidTargetAvailabilityZone	All endpoint vswitchId must be in the target availability zone.
400	InvalidDBProxyNodes.Node	must set DBProxyNodes params with more than 2 proxy 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	InvalidMigrateAZInfo	Invalid MigrateAZ params.
400	InvalidDBProxyNodes.ZoneIdNotUnique	ZoneIds 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.
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	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	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	DBInstanceStatusNotActive	Current DB instance status should be active.
403	InvalidInstanceLevel.Malformed	The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.
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.
403	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.
403	IncorrectKindCode	Current custins kindCode does not support this operation.
403	IncorrectDBType	The current DB type does not support this operation.
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.
403	MaxscaleInstanceNotSupport	Instances with maxscale instance do not support this operation.
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.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.
404	InsufficientResourceCapacity	The target availability zone does not have sufficient resources.
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.