All Products
Search

This Product

    PolarDB:DescribeDBClusterEndpoints

    Document Center

    PolarDB:DescribeDBClusterEndpoints

    Last Updated:Jun 10, 2026

    Menanyakan endpoint dari cluster 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:DescribeDBClusterEndpoints

    get

    *dbcluster

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    ID cluster.

    Catatan

    Anda dapat memanggil operasi DescribeDBClusters untuk menemukan ID semua cluster di akun Anda.

    pc-*************
    DBEndpointId

    string

    No

    ID endpoint cluster.

    pe-*************
    DescribeType

    string

    No

    Menentukan apakah akan mengembalikan informasi tentang node AI.

    AI
    PolarFsInstanceId

    string

    No

    ID instance PolarFS.

    pfs-test*****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan.

    2DC120BF-6EBA-4C63-BE99-B09F9E******
    Items

    array<object>

    Daftar endpoint cluster.

    array<object>

    Nodes

    string

    Daftar node yang dikonfigurasi untuk endpoint.

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

    string

    Mode baca/tulis. Nilai yang valid:

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

    • ReadOnly: hanya-baca.

    ReadOnly
    AddressItems

    array<object>

    Alamat koneksi untuk endpoint.

    object

    VSwitchId

    string

    The vSwitch ID.

    vsw-************
    PrivateZoneConnectionString

    string

    The private domain name.

    ***.***.**.com
    ConnectionString

    string

    The connection string.

    ********.rwlb.polardb-pg-public.rds.aliyuncs.com
    NetType

    string

    The network type. Valid values:

    • Public: the Internet

    • Private: a virtual private cloud (VPC)

    Private
    Port

    string

    The port.

    1521
    VpcInstanceId

    string

    The VPC instance ID.

    Catatan

    This parameter is returned only for PolarDB for MySQL clusters.

    pe-*************
    VPCId

    string

    The VPC ID.

    vpc-***************
    IPAddress

    string

    The IP address.

    192.***.***.***
    DashboardUsed

    boolean

    Indicates whether the address is for the dashboard of a PolarDB Search node.

    • True

    • False: False

    True
    DBEndpointId

    string

    ID endpoint.

    pe-*************
    EndpointConfig

    string

    Pengaturan lanjutan untuk endpoint cluster.

    • DistributedTransaction: Status pemisahan transaksi. Nilai yang valid:

      • on: diaktifkan

      • off: dinonaktifkan

    • ConsistLevel: Tingkat konsistensi. Nilai yang valid:

      • 0: konsistensi akhir (eventual consistency)

      • 1: konsistensi sesi

      • 2: konsistensi global

    • LoadBalanceStrategy: Kebijakan load balancing. Nilainya tetap load, yang menunjukkan penjadwalan berbasis beban.

    • MasterAcceptReads: Menunjukkan apakah node utama menerima permintaan baca. Nilai yang valid:

      • on: Node utama menerima permintaan baca.

      • off: Node utama tidak menerima permintaan baca.

    {\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
    DBEndpointDescription

    string

    Nama endpoint.

    test
    EndpointType

    string

    Jenis endpoint cluster. Nilai yang valid:

    • Cluster: endpoint cluster default.

    • Primary: endpoint utama.

    • Custom: endpoint cluster kustom.

    Custom
    AutoAddNewNodes

    string

    Menunjukkan apakah node baru secara otomatis ditambahkan ke endpoint cluster default. Nilai yang valid:

    • Enable

    • Disable

    Enable
    DBClusterId

    string

    ID cluster.

    pc-bp1s826a1up******
    SccMode

    string

    Menunjukkan apakah konsistensi global (mode performa tinggi) diaktifkan untuk node. Nilai yang valid:

    • on: diaktifkan

    • off: dinonaktifkan

    on
    PolarSccTimeoutAction

    string

    Kebijakan untuk menangani waktu habis baca konsistensi global. Nilai yang valid:

    • 0: Mengalihkan permintaan ke node utama.

    • 2: Menurunkan tingkat permintaan. Jika baca konsistensi global mengalami waktu habis, sistem secara otomatis menurunkan kueri menjadi baca non-konsisten, dan klien tidak menerima kesalahan.

    0
    PolarSccWaitTimeout

    string

    Periode waktu habis untuk baca konsistensi global.

    100
    NodeWithRoles

    string

    Peran setiap node dalam endpoint. Node utama memiliki peran Writer. Node hanya-baca memiliki peran bernomor, seperti Reader1, Reader2, dan seterusnya.

    Catatan

    Parameter ini hanya didukung oleh cluster PolarDB for PostgreSQL dan cluster PolarDB for PostgreSQL (kompatibel dengan Oracle).

    Reader1
    ServiceName

    string

    Nama layanan.

    test-name
    NetType

    string

    Jenis jaringan. Nilai yang valid:

    • Public: jaringan publik

    • Private: jaringan privat

    Private
    VPCId

    string

    ID VPC.

    vpc-***************
    Port

    string

    Port.

    1521
    ConnectionString

    string

    String koneksi.

    ********.rwlb.polardb-pg-public.rds.aliyuncs.com
    Protocol

    string

    Jenis protokol.

    http

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "2DC120BF-6EBA-4C63-BE99-B09F9E******",
  "Items": [
    {
      "Nodes": "pi-***************,pi-***************",
      "ReadWriteMode": "ReadOnly",
      "AddressItems": [
        {
          "VSwitchId": "vsw-************",
          "PrivateZoneConnectionString": "***.***.**.com",
          "ConnectionString": "********.rwlb.polardb-pg-public.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "1521",
          "VpcInstanceId": "pe-*************",
          "VPCId": "vpc-***************",
          "IPAddress": "192.***.***.***",
          "DashboardUsed": true
        }
      ],
      "DBEndpointId": "pe-*************",
      "EndpointConfig": "{\\\"DistributedTransaction\\\":\\\"off\\\",\\\"ConsistLevel\\\":\\\"0\\\",\\\"LoadBalanceStrategy\\\":\\\"load\\\",\\\"MasterAcceptReads\\\":\\\"on\\\"}",
      "DBEndpointDescription": "test",
      "EndpointType": "Custom",
      "AutoAddNewNodes": "Enable",
      "DBClusterId": "pc-bp1s826a1up******",
      "SccMode": "on",
      "PolarSccTimeoutAction": "0",
      "PolarSccWaitTimeout": "100",
      "NodeWithRoles": "Reader1",
      "ServiceName": "test-name",
      "NetType": "Private",
      "VPCId": "vpc-***************",
      "Port": "1521",
      "ConnectionString": "********.rwlb.polardb-pg-public.rds.aliyuncs.com",
      "Protocol": "http"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.