All Products
Search
Document Center

PolarDB:DescribeDBClusterEndpointsZonal

Last Updated:Jun 10, 2026

Mengkueri endpoint dari cluster edge untuk PolarDB pada ENS.

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

get

*全部资源

*

None None

Sintaks permintaan

GET  HTTP/1.1

Parameter permintaan

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

ID cluster.

pc-*************

DBEndpointId

string

No

ID endpoint cluster.

pe-*************

DescribeType

string

No

Menentukan apakah akan mengembalikan informasi tentang node AI.

AI

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan.

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

Items

array<object>

Detail endpoint cluster.

array<object>

DBEndpointId

string

ID endpoint.

pe-*************

PolarSccTimeoutAction

string

Kebijakan untuk waktu habis konsistensi global. Nilai yang valid:

  • 0: Mengirim permintaan ke node utama.

  • 2: Menurunkan tingkat permintaan. Jika pembacaan konsistensi global mengalami waktu habis, kueri secara otomatis diturunkan menjadi permintaan biasa. Klien tidak menerima pesan kesalahan.

0

DBClusterId

string

ID cluster.

pc-bp1s826a1up******

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

DBEndpointDescription

string

Nama endpoint.

test

PolarSccWaitTimeout

string

Periode waktu habis untuk konsistensi global.

100

NodeWithRoles

string

Peran setiap node dalam endpoint. Node utama memiliki peran Writer. Karena beberapa node hanya-baca dapat ditambahkan ke endpoint, setiap node hanya-baca diberi nama peran yang diakhiri dengan angka, seperti Reader1 dan Reader2.

Reader1

AutoAddNewNodes

string

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

  • Enable.

  • Disable.

Enable

EndpointType

string

Tipe endpoint cluster. Nilai yang valid:

  • Cluster: endpoint cluster default.

  • Primary: endpoint utama.

  • Custom: endpoint cluster kustom.

Custom

AddressItems

array<object>

Informasi string koneksi.

object

DashboardUsed

boolean

Specifies whether the endpoint is the dashboard endpoint of a PolarDB search node. Valid values:

  • True: Yes.

  • False: No.

True

PrivateZoneConnectionString

string

The private domain name that is bound to the endpoint.

***.***.**.com

VPCId

string

The ID of the virtual private cloud (VPC).

vpc-***************

VSwitchId

string

The virtual switch ID.

vsw-************

Port

string

The port number.

1521

VpcInstanceId

string

The VPC instance ID.

pe-*************

ConnectionString

string

The connection string.

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

IPAddress

string

The IP address.

192.***.***.***

NetType

string

The network type. Valid values:

  • Public: Internet.

  • Private: internal network.

Private

SccMode

string

Menentukan apakah konsistensi global (mode kinerja tinggi) diaktifkan untuk node. Nilai yang valid:

  • on: aktif.

  • off: nonaktif.

on

EndpointConfig

string

Konfigurasi lanjutan dari endpoint cluster.

  • DistributedTransaction: Status pemisahan transaksi. Nilai yang valid:

    • on: Pemisahan transaksi diaktifkan.

    • off: Pemisahan transaksi dinonaktifkan.

  • ConsistLevel: Tingkat konsistensi. Nilai yang valid:

    • 0: Konsistensi akhir.

    • 1: Konsistensi sesi.

    • 2: Konsistensi global.

  • LoadBalanceStrategy: Kebijakan penyeimbangan beban untuk penjadwalan otomatis berdasarkan beban. Nilai tetap load.

  • MasterAcceptReads: Menentukan 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\"}

Contoh

Respons sukses

JSONformat

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

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.