All Products
Search

This Product

    PolarDB:ModifyDBClusterEndpoint

    Document Center

    PolarDB:ModifyDBClusterEndpoint

    Last Updated:Jun 10, 2026

    Mengubah properti titik akhir kluster PolarDB Basis Data Relasional Cloud-Native. Anda dapat mengonfigurasi pengaturan seperti mode baca/tulis, penambahan node otomatis, tingkat konsistensi, pemisahan transaksi, kolam koneksi, dan apakah node primer 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 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 Basis Data Relasional Cloud-Native for MySQL, tentukan ID node.

    • Untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL dan PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Oracle Compatible), tentukan peran node, seperti Writer,Reader1,Reader2.

    • Jika Anda menetapkan 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 setidaknya dua node untuk meningkatkan ketersediaan.

    • Jika Anda menetapkan ReadWriteMode ke ReadWrite, Anda harus memilih setidaknya dua node. * Untuk PolarDB Basis Data Relasional Cloud-Native for MySQL, Anda dapat memilih dua node mana saja. Jika kedua node adalah node hanya-baca, permintaan tulis dikirim ke node primer. * Untuk PolarDB Basis Data Relasional Cloud-Native for PostgreSQL dan PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Oracle Compatible), Anda harus menyertakan node primer.

    pi-**************,pi-*************
    ReadWriteMode

    string

    No

    Mode baca/tulis. Nilai valid:

    • ReadWrite: Baca/tulis (pemisahan baca/tulis otomatis)

    • ReadOnly: Hanya-baca.

    ReadWrite
    AutoAddNewNodes

    string

    No

    Apakah akan menambahkan node baru secara otomatis ke titik akhir. Nilai 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 menetapkan tingkat konsistensi, pemisahan transaksi, apakah node primer menerima permintaan baca, kolam koneksi, dan pengaturan lainnya.

    • Menetapkan kebijakan load balancing. Format: {\"LoadBalancePolicy\":\"policy\"}. Nilai valid:

      • 0: Load balancing berbasis koneksi (default)

      • 1: Load balancing berbasis permintaan aktif

    • Apakah node primer menerima permintaan baca. Format: {\"MasterAcceptReads\":\"value\"}. Nilai valid:

      • on: Node primer menerima permintaan baca (default).

      • off: Node primer tidak menerima permintaan baca.

    • Mengaktifkan atau menonaktifkan pemisahan transaksi. Format: {\"DistributedTransaction\":\"value\"}. Nilai valid:

      • on: Mengaktifkan pemisahan transaksi (default).

      • off: Menonaktifkan pemisahan transaksi.

    • Menetapkan tingkat konsistensi. Format: {\"ConsistLevel\":\"level\"}. Nilai valid:

      • 0: Konsistensi akhir (lemah)

      • 1: Konsistensi sesi (menengah) (default)

      • 2: Konsistensi global (kuat)

    • Menetapkan periode pengatur waktu habis untuk baca konsistensi global. Format: {\"ConsistTimeout\":\"timeout\"}. Nilai valid: 0 hingga 60000. Nilai default: 20. Unit: ms.

    • Menetapkan periode pengatur waktu habis untuk baca konsistensi sesi. Format: {\"ConsistSessionTimeout\":\"timeout\"}. Nilai valid: 0 hingga 60000. Nilai default: 0. Unit: ms.

    • Menetapkan kebijakan untuk menangani pengatur waktu habis baca konsistensi global atau sesi. Format: {\"ConsistTimeoutAction\":\"policy\"}. Nilai valid:

      • 0: Meneruskan permintaan baca ke node primer (default).

      • 1: Proxy mengembalikan Paket error `wait replication complete timeout, please retry` ke aplikasi.

    • Menetapkan tipe kolam koneksi. Format: {\"ConnectionPersist\":\"type\"}. Nilai valid:

      • off: Menonaktifkan kolam koneksi (default).

      • Session: Mengaktifkan kolam koneksi tingkat sesi.

      • Transaction: Mengaktifkan kolam koneksi tingkat transaksi.

    • Mengaktifkan atau menonaktifkan kueri paralel. Format: {\"MaxParallelDegree\":\"value\"}. Nilai valid:

      • on: Mengaktifkan kueri paralel.

      • off: Menonaktifkan kueri paralel (default).

    • Mengaktifkan atau menonaktifkan perutean otomatis permintaan ke penyimpanan baris atau penyimpanan kolom. Format: {\"EnableHtapImci\":\"value\"}. Nilai valid:

      • on: Mengaktifkan perutean otomatis.

      • off: Menonaktifkan perutean otomatis (default).

    • Mengaktifkan atau menonaktifkan proteksi overload. Format: {\"EnableOverloadThrottle\":\"value\"}. Nilai valid:

      • on: Mengaktifkan proteksi overload.

      • off: Menonaktifkan proteksi overload (default).

    Catatan

    • Anda hanya dapat menetapkan pemisahan transaksi, apakah node primer menerima permintaan baca, kolam koneksi, dan proteksi overload jika mode baca/tulis titik akhir kluster untuk PolarDB Basis Data Relasional Cloud-Native for MySQL ditetapkan ke ReadWrite (pemisahan baca/tulis otomatis).

    • Jika mode baca/tulis titik akhir kluster untuk PolarDB Basis Data Relasional Cloud-Native for MySQL adalah ReadOnly, kebijakan load balancing berbasis koneksi maupun berbasis permintaan aktif didukung. Jika mode baca/tulis adalah ReadWrite (pemisahan baca/tulis otomatis), hanya kebijakan load balancing berbasis permintaan aktif yang didukung.

    • Anda dapat mengaktifkan perutean otomatis ke penyimpanan baris atau penyimpanan kolom jika mode baca/tulis titik akhir kluster untuk PolarDB Basis Data Relasional Cloud-Native for MySQL adalah ReadWrite (pemisahan baca/tulis otomatis), atau jika mode baca/tulis adalah ReadOnly dan kebijakan load balancing adalah berbasis permintaan aktif.

    • Hanya PolarDB Basis Data Relasional Cloud-Native for MySQL yang mendukung konsistensi global.

    • Jika Anda menetapkan parameter ReadWriteMode ke ReadOnly, Anda hanya dapat menetapkan tingkat konsistensi ke 0.

    • Anda dapat menetapkan tingkat konsistensi, pemisahan transaksi, apakah node primer 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 konsistensi adalah 0 (konsistensi akhir). Anda dapat mengaktifkan pemisahan transaksi jika tingkat konsistensi adalah 1 (konsistensi sesi) atau 2 (konsistensi global).

    {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
    DBEndpointDescription

    string

    No

    Nama titik akhir.

    test
    SccMode

    string

    No

    Apakah akan mengaktifkan fitur konsistensi global (mode performa tinggi) untuk node. Nilai valid:

    • ON: Mengaktifkan.

    • OFF: Menonaktifkan.

    on
    PolarSccWaitTimeout

    string

    No

    Periode pengatur waktu habis untuk konsistensi global.

    100
    PolarSccTimeoutAction

    string

    No

    Kebijakan untuk menangani pengatur waktu habis konsistensi global. Nilai valid:

    • 0: Meneruskan permintaan ke node primer.

    • 2: Menurunkan permintaan. Jika baca konsistensi global mengalami pengatur waktu habis, kueri secara otomatis diturunkan menjadi permintaan biasa. Klien tidak menerima Paket error.

    0

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    CD3FA5F3-FAF3-44CA-AFFF-BAF869******

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    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.