Mengkueri endpoint dari cluster edge untuk PolarDB pada ENS.
Coba sekarang
Test
RAM authorization
|
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 |
| DBClusterId |
string |
ID cluster. |
pc-bp1s826a1up****** |
| Nodes |
string |
Daftar node yang dikonfigurasi untuk endpoint. |
pi-***************,pi-*************** |
| ReadWriteMode |
string |
Mode baca/tulis. Nilai yang valid:
|
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 |
| EndpointType |
string |
Tipe endpoint cluster. Nilai yang valid:
|
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 |
| 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:
|
Private |
| SccMode |
string |
Menentukan apakah konsistensi global (mode kinerja tinggi) diaktifkan untuk node. Nilai yang valid:
|
on |
| EndpointConfig |
string |
Konfigurasi lanjutan dari endpoint cluster.
|
{\"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.