ENS 上の PolarDB のエンドポイントを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:DescribeDBClusterEndpointsZonal |
get |
*All resources.
|
なし | なし |
リクエスト構文
GET HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBClusterId |
string |
必須 |
クラスター ID。 説明
注意: エッジクラスター (Zonal) ID のみがサポートされています。通常の PolarDB クラスター ID はサポートされていません。DescribeDBClustersZonal を呼び出して、エッジクラスターのリストを取得できます。 |
pc-************* |
| DBEndpointId |
string |
任意 |
クラスターエンドポイント ID。 |
pe-************* |
| DescribeType |
string |
任意 |
AI ノード情報を返すかどうかを指定します。 |
AI |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
2DC120BF-6EBA-4C63-BE99-B09F9E****** |
| Items |
array<object> |
クラスターエンドポイントの詳細。 |
|
|
array<object> |
|||
| DBEndpointId |
string |
エンドポイント ID。 |
pe-************* |
| PolarSccTimeoutAction |
string |
グローバル整合性タイムアウトポリシー。有効な値:
|
0 |
| DBClusterId |
string |
クラスター ID。 |
pc-bp1s826a1up****** |
| Nodes |
string |
エンドポイントに設定されているノードのリスト。 |
pi-***************,pi-*************** |
| ReadWriteMode |
string |
読み取り/書き込みモード。有効な値:
|
ReadOnly |
| DBEndpointDescription |
string |
エンドポイント名。 |
test |
| PolarSccWaitTimeout |
string |
グローバル整合性タイムアウト期間。 |
100 |
| NodeWithRoles |
string |
対象エンドポイント配下のノードのロール名。プライマリノードは Writer と命名されます。複数の読み取り専用ノードをエンドポイントに追加できるため、各読み取り専用ノードのロール名には区別のために番号が付加されます (Reader1、Reader2 など)。 |
Reader1 |
| AutoAddNewNodes |
string |
新しいノードがデフォルトクラスターエンドポイントに自動的に追加されるかどうかを指定します。有効な値:
|
Enable |
| EndpointType |
string |
クラスターエンドポイントタイプ。有効な値:
|
Custom |
| AddressItems |
array<object> |
接続文字列情報。 |
|
|
object |
|||
| DashboardUsed |
boolean |
アドレスが PolarDB Search ノードのダッシュボードアドレスであるかどうかを指定します。有効な値:
|
True |
| PrivateZoneConnectionString |
string |
バインドされた非公開ドメイン名。 |
***.***.**.com |
| VPCId |
string |
VPC ID。 |
vpc-*************** |
| VSwitchId |
string |
vSwitch ID。 |
vsw-************ |
| Port |
string |
ポート。 |
1521 |
| VpcInstanceId |
string |
VPC 接続インスタンス ID。 |
pe-************* |
| ConnectionString |
string |
接続文字列。 |
********.rwlb.polardb-pg-public.rds.aliyuncs.com |
| IPAddress |
string |
IP アドレス。 |
192.***.***.*** |
| NetType |
string |
ネットワークタイプ。有効な値:
|
Private |
| SccMode |
string |
ノードに対してグローバル整合性 (高性能モード) の特徴が有効かどうかを指定します。有効な値:
|
on |
| EndpointConfig |
string |
クラスターエンドポイントの詳細設定。
|
{\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"} |
例
成功レスポンス
JSONJSON
{
"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\\\"}"
}
]
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。 |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 指定された DBClusterId が現在のレコードに存在しません。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定された DBClusterId がレコードに存在しません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。