CreateDBClusterEndpoint - PolarDB

Membuat titik akhir kluster kustom untuk kluster PolarDB.

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

create

*DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster.	pc-**************
EndpointType	string	Yes	Tipe titik akhir kluster kustom. Tetapkan nilainya ke Custom.	Custom
Nodes	string	No	Node yang akan ditambahkan ke titik akhir. Pisahkan beberapa ID node dengan koma (,). Secara default, semua node ditambahkan. Catatan Untuk PolarDB for MySQL, tentukan ID node. Untuk PolarDB for PostgreSQL dan PolarDB for PostgreSQL (kompatibel dengan Oracle), tentukan nama role node, seperti `Writer,Reader1,Reader2`. Jika Anda menetapkan ReadWriteMode ke ReadOnly, Anda hanya dapat menambahkan satu node. Namun, jika node ini gagal, titik akhir mungkin tidak tersedia hingga 1 jam. Jangan gunakan konfigurasi ini di lingkungan produksi. Tambahkan setidaknya dua node untuk meningkatkan ketersediaan. Jika Anda menetapkan ReadWriteMode ke ReadWrite, Anda harus menambahkan setidaknya dua node. * Untuk PolarDB for MySQL, Anda dapat memilih dua node apa pun. Jika kedua node adalah node read-only, permintaan tulis dikirim ke node primary. * Untuk PolarDB for PostgreSQL dan PolarDB for PostgreSQL (kompatibel dengan Oracle), Anda harus menyertakan node primary.	pi-********,pi-*******
ReadWriteMode	string	No	Mode baca/tulis. Nilai yang valid: ReadWrite: baca dan tulis (pemisahan baca/tulis otomatis). ReadOnly (default): read-only.	ReadOnly
AutoAddNewNodes	string	No	Menentukan apakah node baru secara otomatis ditambahkan ke titik akhir. Nilai yang valid: Enable: Node baru secara otomatis ditambahkan ke titik akhir. Disable (default): Node baru tidak secara otomatis ditambahkan ke titik akhir.	Disable
EndpointConfig	string	No	Konfigurasi lanjutan dari titik akhir kluster. Nilainya berupa string JSON. Anda dapat mengonfigurasi tingkat konsistensi, pemisahan transaksi, kolam koneksi, dan apakah akan membebaskan beban baca dari node primary. Konfigurasikan kebijakan penyeimbangan beban. Formatnya adalah {"LoadBalancePolicy":"policy"}. Nilai yang valid: 0: Penyeimbangan beban berbasis koneksi (default). 1: Penyeimbangan beban berbasis permintaan aktif. Konfigurasikan tingkat konsistensi. Formatnya adalah `{"ConsistLevel":"level"}`. Nilai yang valid: 0: Konsistensi eventual. 1: Konsistensi sesi (default). 2: Konsistensi global. Konfigurasikan pemisahan transaksi. Formatnya adalah `{"DistributedTransaction":"status"}`. Nilai yang valid: on: Aktifkan pemisahan transaksi (default). off: Nonaktifkan pemisahan transaksi. Konfigurasikan apakah akan membebaskan beban baca dari node primary. Formatnya adalah `{"MasterAcceptReads":"status"}`. Nilai yang valid: on: Node primary menerima permintaan baca. off: Node primary tidak menerima permintaan baca (default). Konfigurasikan kolam koneksi. Formatnya adalah `{"ConnectionPersist":"pool"}`. Nilai yang valid: off: Nonaktifkan kolam koneksi (default). Session: Aktifkan pool koneksi tingkat sesi. Transaction: Aktifkan pool koneksi tingkat transaksi. Konfigurasikan kueri paralel. Formatnya adalah {"MaxParallelDegree":"degree"}. Nilai yang valid: Tingkat paralelisme tertentu. Contoh: "MaxParallelDegree":"2". off: Nonaktifkan kueri paralel (default). Konfigurasikan perutean otomatis antara penyimpanan baris dan penyimpanan kolom. Formatnya adalah {"EnableHtapImci":"status"}. Nilai yang valid: on: Aktifkan perutean otomatis antara penyimpanan baris dan penyimpanan kolom. off: Nonaktifkan perutean otomatis antara penyimpanan baris dan penyimpanan kolom (default). Konfigurasikan apakah akan mengaktifkan perlindungan overload. Formatnya adalah {"EnableOverloadThrottle":"status"}. Nilai yang valid: on: Aktifkan perlindungan overload. off: Nonaktifkan perlindungan overload (default). Catatan Anda hanya dapat mengonfigurasi pemisahan transaksi, apakah akan membebaskan beban baca dari node primary, kolam koneksi, dan perlindungan overload ketika mode baca/tulis titik akhir kluster untuk PolarDB for MySQL diatur ke ReadWrite (pemisahan baca/tulis otomatis). Ketika mode baca/tulis titik akhir kluster untuk PolarDB for MySQL adalah read-only, baik penyeimbangan beban berbasis koneksi maupun penyeimbangan beban berbasis permintaan aktif didukung. Ketika mode baca/tulis adalah ReadWrite (pemisahan baca/tulis otomatis), hanya penyeimbangan beban berbasis permintaan aktif yang didukung. Anda dapat mengonfigurasi perutean otomatis antara penyimpanan baris dan penyimpanan kolom ketika mode baca/tulis titik akhir kluster untuk PolarDB for MySQL adalah ReadWrite (pemisahan baca/tulis otomatis), atau ketika mode baca/tulis adalah read-only dan kebijakan penyeimbangan bebannya adalah penyeimbangan beban berbasis permintaan aktif. Hanya PolarDB for MySQL yang mendukung konsistensi global. Jika Anda menetapkan ReadWriteMode ke ReadOnly, Anda hanya dapat menetapkan tingkat konsistensi ke 0. Anda dapat mengonfigurasi tingkat konsistensi, pemisahan transaksi, apakah akan membebaskan beban baca dari node primary, dan kolam koneksi secara bersamaan. Contoh: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`. Pengaturan pemisahan transaksi dibatasi oleh pengaturan tingkat konsistensi. Misalnya, jika tingkat konsistensi adalah 0, Anda tidak dapat mengaktifkan pemisahan transaksi. Jika tingkat konsistensi adalah 1 atau 2, Anda dapat mengaktifkan pemisahan transaksi.	{"ConsistLevel": "1","DistributedTransaction": "on"}
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan nilai tersebut, tetapi Anda harus memastikan bahwa nilainya unik di antara permintaan yang berbeda. Token ini case-sensitive dan tidak boleh melebihi 64 karakter ASCII.	6000170000591aed949d0f******************
DBEndpointDescription	string	No	Nama titik akhir kluster kustom.	test
SccMode	string	No	Menentukan apakah akan mengaktifkan fitur konsistensi global (mode kinerja tinggi) untuk node tersebut. Nilai yang valid: ON: Aktifkan OFF: Nonaktifkan	on
PolarSccWaitTimeout	string	No	Periode timeout untuk konsistensi global.	100
PolarSccTimeoutAction	string	No	Kebijakan untuk menangani timeout baca konsistensi global. Nilai yang valid: 0: Kirim permintaan ke node primary. 2: Turunkan ke permintaan reguler. Jika baca konsistensi global mengalami timeout, kueri secara otomatis diturunkan menjadi permintaan reguler, dan client tidak menerima pesan error.	0
PolarFsInstanceId	string	No		pfs-test****

Elemen respons

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

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ClusterEndpoint.StatusNotValid	Cluster endpoint status is not valid.
400	EndpointNum.Error	Endpoint number error.
400	LockTimeout	The request processing has failed due to lock timeout.
403	OperationDenied.InstanceType	The operation is not permitted due to instance type.
404	EndpointConfig.Invalid	Endpoint config is invalid.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	EndpointConfig.Conflict	Endpoint config is invalid, CausalConsistRead should be session since node SCC mode enabled.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.