ModifyDBClusterEndpoint - PolarDB

Operasi ini memodifikasi properti titik akhir kluster PolarDB, termasuk mode baca/tulis, penambahan node otomatis, tingkat konsistensi, pemisahan transaksi, kolam koneksi, serta apakah node primary menerima permintaan baca.

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

polardb:ModifyDBClusterEndpoint

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster.	pc-*************
DBEndpointId	string	Yes	ID titik akhir kluster.	pe-**************
Nodes	string	No	Node yang akan ditambahkan ke titik akhir untuk distribusi permintaan baca. Pisahkan beberapa ID node dengan koma (,). Node asli digunakan secara default. Catatan Untuk PolarDB for MySQL, tentukan ID node. Untuk PolarDB for PostgreSQL dan PolarDB for PostgreSQL (Oracle Compatible), tentukan peran node, seperti `Writer,Reader1,Reader2`. Jika Anda mengatur ReadWriteMode ke ReadOnly, Anda hanya dapat menyambungkan satu node. Namun, jika node ini gagal, titik akhir mungkin tidak tersedia hingga satu jam. Jangan gunakan konfigurasi ini di lingkungan produksi. Pilih minimal dua node untuk meningkatkan ketersediaan. Jika Anda mengatur ReadWriteMode ke ReadWrite, Anda harus memilih minimal dua node. * Untuk PolarDB for MySQL, Anda dapat memilih node apa pun. Jika kedua node adalah node read-only, permintaan tulis dikirim ke node primary. * Untuk PolarDB for PostgreSQL dan PolarDB for PostgreSQL (Oracle Compatible), Anda harus menyertakan node primary.	pi-************,pi-***********
ReadWriteMode	string	No	Mode baca/tulis. Nilai yang valid: ReadWrite: Baca/tulis (automatic read/write splitting) ReadOnly: Read-only	ReadWrite
AutoAddNewNodes	string	No	Menentukan apakah node baru ditambahkan secara otomatis ke titik akhir. Nilai yang valid: Enable: Menambahkan node baru secara otomatis. Disable: Tidak menambahkan node baru secara otomatis. Ini adalah nilai default.	Enable
EndpointConfig	string	No	Konfigurasi lanjutan titik akhir kluster dalam format JSON. Anda dapat mengatur tingkat konsistensi, pemisahan transaksi, apakah node primary menerima permintaan baca, kolam koneksi, dan pengaturan lainnya. Mengatur kebijakan penyeimbangan beban. Format: `{\"LoadBalancePolicy\":\"policy\"}`. Nilai yang valid: 0: Penyeimbangan beban berbasis koneksi (default) 1: Penyeimbangan beban berbasis permintaan aktif Menentukan apakah node primary menerima permintaan baca. Format: `{\"MasterAcceptReads\":\"value\"}`. Nilai yang valid: on: Node primary menerima permintaan baca (default). off: Node primary tidak menerima permintaan baca. Mengaktifkan atau menonaktifkan pemisahan transaksi. Format: `{\"DistributedTransaction\":\"value\"}`. Nilai yang valid: on: Mengaktifkan pemisahan transaksi (default). off: Menonaktifkan pemisahan transaksi. Mengatur tingkat konsistensi. Format: `{\"ConsistLevel\":\"level\"}`. Nilai yang valid: 0: Eventual consistency (lemah) 1: Session consistency (menengah) (default) 2: Global consistency (kuat) Mengatur periode timeout untuk bacaan konsistensi global. Format: `{\"ConsistTimeout\":\"timeout\"}`. Nilai yang valid: 0 hingga 60000. Nilai default: 20. Satuan: ms. Mengatur periode timeout untuk bacaan konsistensi sesi. Format: `{\"ConsistSessionTimeout\":\"timeout\"}`. Nilai yang valid: 0 hingga 60000. Nilai default: 0. Satuan: ms. Mengatur kebijakan penanganan timeout untuk bacaan konsistensi global atau sesi. Format: `{\"ConsistTimeoutAction\":\"policy\"}`. Nilai yang valid: 0: Meneruskan permintaan baca ke node primary (default). 1: Proxy mengembalikan pesan error `wait replication complete timeout, please retry` ke aplikasi. Mengatur tipe kolam koneksi. Format: `{\"ConnectionPersist\":\"type\"}`. Nilai yang valid: off: Menonaktifkan kolam koneksi (default). Session: Mengaktifkan pool koneksi tingkat sesi. Transaction: Mengaktifkan kolam koneksi tingkat transaksi. Mengaktifkan atau menonaktifkan parallel query. Format: `{\"MaxParallelDegree\":\"value\"}`. Nilai yang valid: on: Mengaktifkan parallel query. off: Menonaktifkan parallel query (default). Mengaktifkan atau menonaktifkan routing otomatis permintaan ke penyimpanan baris atau penyimpanan kolom. Format: `{\"EnableHtapImci\":\"value\"}`. Nilai yang valid: on: Mengaktifkan routing otomatis. off: Menonaktifkan routing otomatis (default). Mengaktifkan atau menonaktifkan overload protection. Format: `{\"EnableOverloadThrottle\":\"value\"}`. Nilai yang valid: on: Mengaktifkan overload protection. off: Menonaktifkan overload protection (default). Catatan Anda hanya dapat mengatur pemisahan transaksi, apakah node primary menerima permintaan baca, kolam koneksi, dan overload protection ketika mode baca/tulis titik akhir kluster untuk PolarDB for MySQL diatur ke ReadWrite (automatic read/write splitting). Jika mode baca/tulis titik akhir kluster untuk PolarDB for MySQL adalah ReadOnly, kebijakan penyeimbangan beban berbasis connections-based dan active requests-based didukung. Jika mode baca/tulis adalah ReadWrite (automatic read/write splitting), hanya kebijakan penyeimbangan beban berbasis active requests-based yang didukung. Anda dapat mengaktifkan routing otomatis ke penyimpanan baris atau penyimpanan kolom jika mode baca/tulis titik akhir kluster untuk PolarDB for MySQL adalah ReadWrite (automatic read/write splitting), atau jika mode baca/tulis adalah ReadOnly dan kebijakan penyeimbangan bebannya adalah active requests-based. Hanya PolarDB for MySQL yang mendukung global consistency. Jika Anda mengatur parameter ReadWriteMode ke ReadOnly, Anda hanya dapat mengatur tingkat konsistensi ke 0. Anda dapat mengatur tingkat konsistensi, pemisahan transaksi, apakah node primary menerima permintaan baca, dan kolam koneksi secara bersamaan. Contoh: `{\"ConsistLevel\":\"1\",\"DistributedTransaction\":\"on\",\"ConnectionPersist\":\"Session\",\"MasterAcceptReads\":\"on\"}`. Pengaturan pemisahan transaksi dibatasi oleh tingkat konsistensi. Misalnya, Anda tidak dapat mengaktifkan pemisahan transaksi jika tingkat konsistensinya adalah 0 (eventual consistency). Anda dapat mengaktifkan pemisahan transaksi jika tingkat konsistensinya adalah 1 (session consistency) atau 2 (global consistency).	{"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
DBEndpointDescription	string	No	Nama titik akhir.	test
SccMode	string	No	Menentukan apakah fitur konsistensi global (mode kinerja tinggi) diaktifkan untuk node tersebut. Nilai yang valid: ON: Aktifkan OFF: Nonaktifkan	on
PolarSccWaitTimeout	string	No	Periode timeout untuk konsistensi global.	100
PolarSccTimeoutAction	string	No	Kebijakan penanganan timeout konsistensi global. Nilai yang valid: 0: Meneruskan permintaan ke node primary. 2: Menurunkan permintaan. Jika bacaan konsistensi global melebihi waktu timeout, kueri secara otomatis diturunkan menjadi permintaan biasa. Klien tidak menerima pesan error.	0

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	CD3FA5F3-FAF3-44CA-AFFF-BAF869******

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidEndpointConfig.Malformed	The specified parameter EndpointConfig is not valid.
400	InvalidDBEndpointId.Malformed	The specified parameter DBEndpointId is not valid.
400	InvalidNodes.Malformed	The specified parameter Nodes is not valid.
403	OperationDenied.InstanceType	The operation is not permitted due to instance type.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	EndpointStatus.NotSupport	Current endpoint status does not support this operation.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.