All Products
Search

This Product

    PolarDB:ModifyDBClusterEndpoint

    Document Center

    PolarDB:ModifyDBClusterEndpoint

    Last Updated:Sep 11, 2026

    Mengubah atribut titik akhir kluster pada kluster PolarDB Basis Data Relasional Cloud-Native, termasuk mode baca/tulis, penambahan node baru secara otomatis ke titik akhir, tingkat konsistensi, pemisahan transaksi, penerimaan permintaan baca oleh node utama, dan Pooling koneksi.

    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 beban baca yang akan ditambahkan ke titik akhir. Pisahkan beberapa node dengan koma (,). Nilai default: node yang ada.

    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 (Compatible with Oracle), tentukan nama peran node, seperti Writer,Reader1,Reader2.

    • Jika ReadWriteMode diatur ke ReadOnly, Anda hanya dapat memasang satu node. Namun, jika node ini gagal, titik akhir mungkin tidak tersedia hingga 1 jam. Jangan gunakan konfigurasi ini di lingkungan produksi. Pilih setidaknya 2 node untuk meningkatkan ketersediaan.

    • Jika ReadWriteMode diatur ke ReadWrite, pilih setidaknya 2 node. * PolarDB Basis Data Relasional Cloud-Native for MySQL memungkinkan Anda memilih dua node apa pun. Jika kedua node adalah node baca-saja, permintaan tulis akan diteruskan ke node utama. * PolarDB Basis Data Relasional Cloud-Native for PostgreSQL dan PolarDB Basis Data Relasional Cloud-Native for PostgreSQL (Compatible with Oracle) mewajibkan node utama untuk disertakan.

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

    string

    No

    Mode baca/tulis. Nilai valid:

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

    • ReadOnly: baca-saja

    ReadWrite
    AutoAddNewNodes

    string

    No

    Apakah node baru secara otomatis ditambahkan ke titik akhir. Nilai valid:

    • Enable: Node baru secara otomatis ditambahkan.

    • Disable: Node baru tidak secara otomatis ditambahkan. (Default)

    Enable
    EndpointConfig

    string

    No

    Konfigurasi lanjutan titik akhir kluster dalam format JSON. Anda dapat mengonfigurasi tingkat konsistensi, pemisahan transaksi, apakah node utama menerima permintaan baca, dan Pooling koneksi.

    • Untuk mengatur kebijakan penyeimbangan beban, gunakan format {\"LoadBalancePolicy\":\"Kebijakan penyeimbangan beban\"}. Nilai valid:

      • 0: penyeimbangan beban berbasis koneksi (default)

      • 1: penyeimbangan beban berbasis permintaan aktif

    • Untuk mengatur apakah node utama menerima permintaan baca, gunakan format {\"MasterAcceptReads\":\"Apakah node utama menerima baca\"}. Nilai valid:

      • on: Node utama menerima permintaan baca. (Default)

      • off: Node utama tidak menerima permintaan baca.

    • Untuk mengatur pemisahan transaksi, gunakan format {\"DistributedTransaction\":\"Pemisahan transaksi\"}. Nilai valid:

      • on: Pemisahan transaksi diaktifkan. (Default)

      • off: Pemisahan transaksi dinonaktifkan.

    • Untuk mengatur tingkat konsistensi, gunakan format {\"ConsistLevel\":\"Tingkat konsistensi\"}. Nilai valid:

      • 0: konsistensi akhir (lemah)

      • 1: konsistensi sesi (menengah) (default)

      • 2: konsistensi global (kuat)

    • Untuk mengatur periode waktu tunggu baca konsistensi global, gunakan format {\"ConsistTimeout\":\"Waktu tunggu baca konsistensi global\"}. Nilai valid: 0 hingga 60000. Nilai default: 20. Unit: ms.

    • Untuk mengatur periode waktu tunggu baca konsistensi sesi, gunakan format {\"ConsistSessionTimeout\":\"Waktu tunggu baca konsistensi sesi\"}. Nilai valid: 0 hingga 60000. Nilai default: 0. Unit: ms.

    • Untuk mengatur pengatur waktu tunggu baca konsistensi global (atau sesi), gunakan format {\"ConsistTimeoutAction\":\"Pengatur waktu tunggu baca konsistensi global\"}. Nilai valid:

      • 0: Meneruskan permintaan baca ke node utama. (Default)

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

    • Untuk mengatur Kolam koneksi, gunakan format {\"ConnectionPersist\":\"Kolam koneksi\"}. Nilai valid:

      • off: Kolam koneksi dinonaktifkan. (Default)

      • Session: Kolam koneksi tingkat sesi diaktifkan.

      • Transaction: Pooling koneksi tingkat transaksi diaktifkan.

    • Untuk mengatur kueri paralel, gunakan format {\"MaxParallelDegree\":\"Kueri paralel\"}. Nilai valid:

      • on: Kueri paralel diaktifkan.

      • off: Kueri paralel dinonaktifkan. (Default)

    • Untuk mengatur distribusi permintaan otomatis di antara pembacaan offload baris dari node utama, gunakan format {\"EnableHtapImci\":\"Distribusi permintaan otomatis di antara penyimpanan baris dan penyimpanan kolom\"}. Nilai valid:

      • on: Distribusi permintaan otomatis di antara pembacaan offload baris dari node utama diaktifkan.

      • off: Distribusi permintaan otomatis di antara pembacaan offload baris dari node utama dinonaktifkan. (Default)

    • Untuk mengatur apakah akan mengaktifkan perlindungan kelebihan beban, gunakan format {\"EnableOverloadThrottle\":\"Apakah akan mengaktifkan perlindungan kelebihan beban\"}. Nilai valid:

      • on: Perlindungan kelebihan beban diaktifkan.

      • off: Perlindungan kelebihan beban dinonaktifkan. (Default)

    • Untuk mengatur bobot node, gunakan format {\"NodesWeight\":{\"ID Node\":\"Nilai bobot\"}}.

    Catatan

    • Pemisahan transaksi, penerimaan permintaan baca oleh node utama, Pooling koneksi, dan perlindungan kelebihan beban hanya dapat dikonfigurasi ketika mode baca/tulis titik akhir kluster PolarDB Basis Data Relasional Cloud-Native for MySQL adalah ReadWrite (pemisahan baca/tulis otomatis).

    • Ketika mode baca/tulis titik akhir kluster PolarDB Basis Data Relasional Cloud-Native for MySQL adalah ReadOnly, kedua kebijakan penyeimbangan beban berbasis koneksi dan penyeimbangan beban berbasis permintaan aktif didukung. Mode ReadWrite (pemisahan baca/tulis otomatis) hanya mendukung kebijakan penyeimbangan beban berbasis permintaan aktif.

    • Distribusi permintaan otomatis di antara pembacaan offload baris dari node utama dapat dikonfigurasi ketika mode baca/tulis titik akhir kluster PolarDB Basis Data Relasional Cloud-Native for MySQL adalah ReadWrite (pemisahan baca/tulis otomatis), atau ketika mode baca/tulis adalah ReadOnly dan kebijakan penyeimbangan beban adalah penyeimbangan beban berbasis permintaan aktif.

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

    • Jika ReadWriteMode diatur ke ReadOnly, tingkat konsistensi hanya dapat diatur ke 0.

    • Anda dapat mengonfigurasi tingkat konsistensi, pemisahan transaksi, penerimaan permintaan baca oleh node utama, dan Pooling koneksi secara bersamaan. Contoh: {\"ConsistLevel\":\"1\",\"DistributedTransaction\":\"on\",\"ConnectionPersist\":\"Session\",\"MasterAcceptReads\":\"on\"}.

    • Pemisahan transaksi dibatasi oleh tingkat konsistensi. Misalnya, pemisahan transaksi tidak dapat diaktifkan ketika tingkat konsistensi adalah 0. Pemisahan transaksi dapat diaktifkan ketika tingkat konsistensi adalah 1 atau 2.

    {"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 kinerja tinggi) untuk node. Nilai valid:

    • ON: Diaktifkan.

    • OFF: Dinonaktifkan.

    on
    PolarSccWaitTimeout

    string

    No

    Periode pengatur waktu untuk konsistensi global.

    100
    PolarSccTimeoutAction

    string

    No

    Kebijakan pengatur waktu untuk konsistensi global. Nilai valid:

    • 0: Mengirim permintaan ke node utama.

    • 2: Degradasi pengatur waktu. Ketika baca konsistensi global mencapai pengatur waktu, kueri secara otomatis diturunkan ke permintaan reguler, dan klien tidak menerima Paket 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

    Description
    400 InvalidEndpointConfig.Malformed The specified parameter EndpointConfig is not valid. Parameter EndpointConfig yang ditentukan tidak valid.
    400 InvalidDBEndpointId.Malformed The specified parameter DBEndpointId is not valid. Parameter DBEndpointId yang ditentukan tidak valid.
    400 InvalidNodes.Malformed The specified parameter Nodes is not valid. Parameter Nodes yang ditentukan tidak valid.
    403 OperationDenied.InstanceType The operation is not permitted due to instance type. Operasi tidak diizinkan karena tipe instans.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. Operasi gagal karena ID instans kluster yang ditentukan tidak ada.
    404 EndpointStatus.NotSupport Current endpoint status does not support this operation. Status node saat ini tidak mendukung operasi ini.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. DBClusterId yang diberikan tidak ada dalam catatan kami.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. DBClusterId yang diberikan tidak ada dalam catatan saat ini.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.