ModifyDBProxyEndpoint - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengonfigurasi kebijakan akses titik akhir proksi database untuk instans ApsaraDB RDS.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL

Dokumentasi fitur terkait

Penting Sebelum menggunakan operasi ini, baca dokumentasi fitur dengan saksama untuk memastikan Anda sepenuhnya memahami prasyarat dan dampak penggunaan operasi ini.

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

update

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil DescribeDBInstances untuk mengkueri ID.	rm-bp145737x5bi6****
DBProxyEndpointId	string	No	ID titik akhir proksi. Anda dapat memanggil DescribeDBProxyEndpoint untuk mengkueri ID. Catatan MySQL: Parameter ini diperlukan saat DbEndpointOperator diatur ke Delete atau Modify. PostgreSQL: Parameter ini diperlukan saat DbEndpointOperator diatur ke Delete, Modify, atau Create.	gos787jog2wk0y****
ConfigDBProxyFeatures	string	No	Fitur proksi yang ingin Anda aktifkan untuk titik akhir proksi. Pisahkan beberapa fitur dengan titik koma (;). Format: `Feature1:Status;Feature2:Status;...`, tanpa titik koma (;) di akhir. Fitur valid: ReadWriteSpliting: pemisahan baca/tulis ConnectionPersist: pooling koneksi TransactionReadSqlRouteOptimizeStatus: pemisahan transaksi AZProximityAccess: akses terdekat CausalConsistRead: konsistensi baca HtapFilter: perutean baris-kolom otomatis HTAP Nilai status valid: 1: Fitur diaktifkan. 0: Fitur dinonaktifkan. Catatan Untuk RDS PostgreSQL, hanya ReadWriteSpliting yang didukung. Fitur akses terdekat hanya didukung oleh proksi khusus RDS MySQL.	ReadWriteSpliting:1;ConnectionPersist:0
RegionId	string	No	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri ID.	cn-hangzhou
ReadOnlyInstanceMaxDelayTime	string	No	Ambang batas latensi maksimum instans hanya baca dalam mode pemisahan baca/tulis. Ketika latensi instans hanya baca melebihi nilai ini, trafik baca tidak diteruskan ke instans tersebut. Unit: detik. Jika Anda tidak menentukan parameter ini, nilai asli akan dipertahankan. Nilai valid: 0 hingga 3600. Catatan Parameter ini hanya diperlukan saat pemisahan baca/tulis diaktifkan. Nilai default: 30 detik saat atribut baca/tulis adalah baca/tulis (pemisahan baca/tulis); -1 (dinonaktifkan) saat atribut baca/tulis adalah hanya baca.	30
CausalConsistReadTimeout	string	No	Periode pengatur waktu untuk pembacaan konsisten. Unit: milidetik. Nilai default: 10. Nilai valid: 0 hingga 60000.	10
ReadOnlyInstanceDistributionType	string	No	Mode alokasi bobot baca. Nilai valid: Standard: nilai default. Bobot dialokasikan secara otomatis berdasarkan spesifikasi instans. Custom: bobot dialokasikan secara manual. Catatan Parameter ini hanya diperlukan saat pemisahan baca/tulis diaktifkan. Untuk informasi lebih lanjut tentang mode alokasi bobot baca, lihat Alokasi bobot baca untuk MySQL atau Mengaktifkan dan mengonfigurasi layanan proksi database untuk PostgreSQL.	Standard
ReadOnlyInstanceWeight	string	No	Alokasi bobot baca kustom. Tentukan bobot permintaan baca untuk instans utama dan instans hanya baca. Bobot dinaikkan dalam langkah 100, dan nilai maksimum adalah 10000. Format: Instans reguler: `{"Primary instance ID":"Weight","Read-only instance ID":"Weight"...}` Contoh: `{"rm-uf6wjk5**":"500","rr-tfhfgk5xxx":"200"...}` Instans kluster RDS MySQL: `{"Read-only instance ID":"Weight","DBClusterNode":{"Primary node ID":"Weight","Secondary node ID":"Weight","Secondary node ID":"Weight"...}}` Contoh: `{"rr-tfhfgk5":"200","DBClusterNode":{"rn-2z":"0","rn-2z":"400","rn-2z":"400"...}}` Catatan DBClusterNode adalah informasi permintaan yang eksklusif untuk instans kluster. Ini berisi NodeID dan Weight** dari node utama dan sekunder.	{"rm-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}
DBInstanceId	string	Yes	The instance ID. You can call DescribeDBInstances to query the ID.	rm-bp145737x5bi6****
DbEndpointOperator	string	No	Jenis operasi. Nilai valid: Modify: nilai default. Mengubah titik akhir proksi. Create: membuat titik akhir proksi. Delete: menghapus titik akhir proksi.	Modify
DbEndpointAliases	string	No	Keterangan titik akhir proksi.	test-proxy
DbEndpointType	string	No	Tipe titik akhir proksi. Ini adalah parameter yang dicadangkan dan tidak perlu diatur.	RWSplit
DbEndpointReadWriteMode	string	No	Mode baca/tulis. Nilai valid: ReadWrite: terhubung ke instans utama dan menerima permintaan tulis. ReadOnly: nilai default. Tidak terhubung ke instans utama dan tidak dapat menerima permintaan tulis. Catatan Parameter ini diperlukan saat DbEndpointOperator diatur ke Create. Untuk instans RDS MySQL, saat nilai parameter ini diubah dari ReadWrite menjadi ReadOnly, fitur pemisahan transaksi dinonaktifkan.	ReadWrite
DBProxyEngineType	string	No	Parameter ini tidak digunakan lagi dan tidak perlu dikonfigurasi.	normal
VSwitchId	string	No	ID vSwitch zona untuk titik akhir proksi. Nilai default adalah ID vSwitch titik akhir default dari instans proksi. Anda dapat memanggil operasi DescribeVSwitches untuk mengkueri vSwitch yang telah dibuat.	vsw-uf6adz52c2p****
EffectiveTime	string	No	Waktu saat konfigurasi berlaku. Nilai valid: Immediate: berlaku segera. MaintainTime: berlaku selama jendela pemeliharaan. Untuk informasi lebih lanjut, lihat ModifyDBInstanceMaintainTime. SpecificTime: berlaku pada waktu yang ditentukan. Nilai default: MaintainTime.	MaintainTime
EffectiveSpecificTime	string	No	Waktu saat konfigurasi berlaku. Format: yyyy-MM-ddTHH:mm:ssZ (waktu UTC). Catatan Parameter ini diperlukan saat EffectiveTime diatur ke SpecificTime.	2023-05-06T07:08:09Z
DbEndpointMinSlaveCount	string	No	Jumlah minimum instans yang dicadangkan.	2
VpcId	string	No
VpcId	string	No	ID VPC zona untuk titik akhir proksi. Nilai default adalah ID VPC titik akhir default dari instans proksi. Anda dapat memanggil operasi DescribeDBInstanceAttribute untuk mengkueri VPC default instans.	vpc-2zeusejj******

Elemen respons

Element	Type	Description	Example
	object	Detail tentang parameter tanggapan.
RequestId	string	ID permintaan.	6B50D92C-1960-4D4F-A290-AFADD6B1A5C8

Contoh

Respons sukses

JSONformat

{
  "RequestId": "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidVpcInstanceId	The specified VPC instance ID is invalid.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.
400	InvalidEndpointType.Format	The specified EndpointType is invalid.
400	IncorrectDBInstanceNetType	The current database instance network type does not support the operation.
400	EndpointNum.Error	The number of endpoint is invalid.
400	EndpointTypeOperation.NotSupport	The endpoint type does not support the operation.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.
400	ClusterEndpoint.StatusNotValid	The cluster endpoint status is invalid.
400	MaxscaleNotSupport	Current custins can not support Maxscale.
400	InvalidAvZone.Format	Specified AvZone 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	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	APICallingFailed	Api calling failed.
400	InvalidVSwitchId.Format	The specified vswitch Id format is incorrect.
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	MaxScaleLevel.NotSupport	The current maxscale ins_num does not support this operation.
403	ReadDBInstance.NotFound	The current database instance does not contain any read only instance.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.
403	IncorrectDBInstanceState	The current database instance state does not support the operation.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.
403	IncorrectDBInstanceType	Current DB instance type does 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	InvalidVswitchId	Specified conn vswitch id is not valid.
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	EndpointConfig.Invalid	Please check the endpoint config parameter.
404	Readins.NotFound	The current instance does not contain any read only instance. The operation is not supported.
404	Endpoint.NotFound	Specified endpoint is not found.
404	EndpointType.NotFound	The specified endpoint type is not found.
404	InvalidReadDBInstance.NotFound	The specified read only database instance does not exist.
404	InvalidParam	The specified Weight is invalid.
404	Maxscale.NotFound	The related maxscale instance is not found.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.
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.