DescribeDBClusterEndpoints - PolarDB

Mengambil informasi titik akhir 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:DescribeDBClusterEndpoints

get

*dbcluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster. Catatan Panggil operasi DescribeDBClusters untuk menanyakan detail semua kluster dalam akun Anda, termasuk ID kluster tersebut.	pc-*************
DBEndpointId	string	No	ID titik akhir kluster.	pe-*************
DescribeType	string	No	Menentukan apakah akan mengembalikan informasi tentang node AI.	AI
PolarFsInstanceId	string	No		pfs-test*****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	2DC120BF-6EBA-4C63-BE99-B09F9E******
Items	array<object>	Detail titik akhir kluster.
	array<object>
Nodes	string	Daftar node yang dikonfigurasi untuk titik akhir tersebut.	pi-*************,pi-*************
ReadWriteMode	string	Mode baca/tulis. Nilai yang valid: ReadWrite: baca dan tulis (pemisahan baca/tulis otomatis). ReadOnly: read-only.	ReadOnly
AddressItems	array<object>	Informasi mengenai string koneksi.
	object
VSwitchId	string	ID virtual switch.	vsw-************
PrivateZoneConnectionString	string	Nama domain pribadi yang terikat ke titik akhir tersebut.	*..*.com
ConnectionString	string	String koneksi.	********.rwlb.polardb-pg-public.rds.aliyuncs.com
NetType	string	Jenis jaringan. Nilai yang valid: Public: jaringan publik Private: jaringan pribadi	Private
Port	string	Port.	1521
VpcInstanceId	string	ID instans VPC. Catatan Parameter ini hanya dikembalikan untuk kluster PolarDB for MySQL.	pe-*************
VPCId	string	ID VPC.	vpc-***************
IPAddress	string	Alamat IP.	192.*..**
DashboardUsed	boolean	Menunjukkan apakah titik akhir tersebut merupakan titik akhir Dasbor untuk node PolarDB Search. True: ya False: tidak	True
DBEndpointId	string	ID titik akhir.	pe-*************
EndpointConfig	string	Konfigurasi lanjutan dari titik akhir kluster. DistributedTransaction: Status pemisahan transaksi. Nilai yang valid: on: diaktifkan off: dinonaktifkan ConsistLevel: Tingkat konsistensi sesi. Nilai yang valid: 0: konsistensi akhir 1: konsistensi sesi 2: konsistensi global LoadBalanceStrategy: Kebijakan penyeimbangan beban. Nilainya tetap sebagai load, yang menunjukkan penjadwalan berbasis beban. MasterAcceptReads: Menentukan apakah node primary menerima permintaan baca. Nilai yang valid: on: Node primary menerima permintaan baca. off: Node primary tidak menerima permintaan baca.	{\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
DBEndpointDescription	string	Nama titik akhir.	test
EndpointType	string	Jenis titik akhir kluster. Nilai yang valid: Cluster: titik akhir kluster default. Primary: titik akhir utama. Custom: titik akhir kluster kustom.	Custom
AutoAddNewNodes	string	Menunjukkan apakah node baru secara otomatis ditambahkan ke titik akhir kluster default. Nilai yang valid: Enable Disable	Enable
DBClusterId	string	ID kluster.	pc-bp1s826a1up******
SccMode	string	Menunjukkan apakah konsistensi global (mode kinerja tinggi) diaktifkan untuk node tersebut. Nilai yang valid: on: diaktifkan off: dinonaktifkan	on
PolarSccTimeoutAction	string	Kebijakan untuk menangani timeout bacaan konsistensi global. Nilai yang valid: 0: Kirim permintaan ke node primary. 2: Menurunkan spesifikasi permintaan. Jika bacaan konsistensi global mengalami timeout, kueri secara otomatis diturunkan menjadi permintaan biasa, dan klien tidak menerima pesan error.	0
PolarSccWaitTimeout	string	Timeout konsistensi global.	100
NodeWithRoles	string	Peran setiap node dalam titik akhir tersebut. Node primary memiliki peran Writer. Karena beberapa node read-only dapat ditambahkan ke titik akhir, peran setiap node read-only dibedakan dengan angka, seperti Reader1, Reader2, dan seterusnya. Catatan Parameter ini hanya didukung oleh kluster PolarDB for PostgreSQL dan kluster PolarDB for PostgreSQL (kompatibel dengan Oracle).	Reader1

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"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
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.