この操作を呼び出すと、指定した ApsaraDB for PolarDB クラスターのエンドポイントを照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須項目 例 説明
Action String いいえ DescribeDBClusterEndpoints

実行する操作。 値を DescribeDBClusterEndpoints に設定します。

DBClusterId String はい pc-xxxxxxxxxx

クラスターの ID。
DBEndpointId String いいえ pe-xxxxxxxx

クラスターエンドポイントの ID。 例: pe-xxxxxxxx。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String ABA96273-606B-4616-9394-336A06312713

リクエストの ID。
Items Array

クラスターエンドポイントの ID。
DBEndpointId String pe-xxxxxxxxxx

クラスターエンドポイントの ID。
EndpointType String Cluster

クラスターエンドポイントのタイプ。 設定可能な値は以下のとおりです。

  • Cluster: クラスターのデフォルトエンドポイント。
  • Primary: クラスターのプライマリエンドポイント。
  • Custom: クラスターのカスタムエンドポイント。
Nodes String pi-xxxxxxxxxx,pi-xxxxxxxxxx

エンドポイント用に構成されたノードのリスト。
ReadWriteMode String ReadWrite

エンドポイントの読み取り/書き込みモード。 設定可能な値は以下のとおりです。

  • ReadWrite: 読み取りおよび書き込みリクエストを受信して転送します (自動読み書き分離)。
  • ReadOnly: 読み取り専用。
AutoAddNewNodes String Enable

このエンドポイントに新しく追加されたノードを自動的に追加するかどうかを示します。 設定可能な値は以下のとおりです。

  • Enable
  • Disable
EndpointConfig String {\"DistributedTransaction\":\"off\",\"TrackLSNPerTab\":\"on\",\"ConsistLevel\":\"1\",\"StrictSPCalls\":\"on\",\"CausalConsistRead\":\"1\",\"StrictMultiStmt\":\"on\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"

クラスターエンドポイントの詳細構成。

  • DistributedTransaction: トランザクションの分割ステータス。 設定可能な値は以下のとおりです。
    • on: トランザクション分割が有効になっています。
    • off: トランザクション分割が無効になっています。
  • ConsistLevel: セッションの整合性レベル。 設定可能な値は以下のとおりです。
    • 0: 結果整合性
    • 1: セッション整合性
  • LoadBalanceStrategy: 負荷を自動的にスケジュールするロードバランスポリシー。 有効な値: load。
AddressItems Array

接続文字列に関する情報。
ConnectionString String pc-xxxxxxxxxx.w.polardb.cn-qd-pldb1.rds.aliyuncs.com

接続文字列。
IPAddress String 172.xx.xx.xx

IP アドレス。
NetType String Private

クラスターエンドポイントのネットワークタイプ。 設定可能な値は以下のとおりです。

  • Public: パブリックネットワーク
  • Private: プライベートネットワーク
Port String 3306

クラスターエンドポイントのポート番号。
VPCId String vpc-xxxxxxxxxx

クラスターエンドポイントの VPC ID。
VSwitchId String vsw-xxxxxxxxxx

クラスターエンドポイントの VSwitch ID。

例

リクエストの例

http(s)://[Endpoint]/? Action=DescribeDBClusterEndpoints
&DBClusterId=pc-xxxxxxxxxx
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<Items>
    <EndpointType>Cluster</EndpointType>
    <AutoAddNewNodes>Enable</AutoAddNewNodes>
    <ReadWriteMode>ReadWrite</ReadWriteMode>
    <AddressItems>
        <Port>3306</Port>
        <ConnectionString>pc-bpxxxxxxxx.rwlb.rds.aliyuncs.com</ConnectionString>
        <VPCId>vpc-bpxxxxxxxx</VPCId>
        <IPAddress>192.168.xx.xxx</IPAddress>
        <NetType>Private</NetType>
        <VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
    </AddressItems>
    <Nodes>pi-bpxxxxxxxx,pi-bpxxxxxxxx</Nodes>
    <DBEndpointId>pe-bpxxxxxxxx</DBEndpointId>
    <EndpointConfig>{"DistributedTransaction":"off","TrackLSNPerTab":"on","ConsistLevel":"1","StrictSPCalls":"on","CausalConsistRead":"1","StrictMultiStmt":"on","LoadBalanceStrategy":"load","MasterAcceptReads":"on"}</EndpointConfig>
</Items>
<Items>
    <EndpointType>Primary</EndpointType>
    <AddressItems>
        <Port>3306</Port>
        <ConnectionString>pc-bpxxxxxxxx.mysql.polardb.rds.aliyuncs.com</ConnectionString>
        <VPCId>vpc-bpxxxxxxxx</VPCId>
        <IPAddress>192.168.xx.xxx</IPAddress>
        <NetType>Private</NetType>
        <VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
    </AddressItems>
    <Nodes>pi-bpxxxxxxxx</Nodes>
    <DBEndpointId>pe-bpxxxxxxxx</DBEndpointId>
    <EndpointConfig>{}</EndpointConfig>
</Items>
<RequestId>0E6CDE6C-107C-48C0-8995-BA976DF558A2</RequestId>

JSON 形式 

{
    "Items": [
        {
            "EndpointType": "Cluster",
            "AutoAddNewNodes": "Enable",
            "ReadWriteMode": "ReadWrite",
            "AddressItems": [
                {
                    "Port": "3306",
                    "ConnectionString": "pc-bpxxxxxxxx.rwlb.rds.aliyuncs.com",
                    "VPCId": "vpc-bpxxxxxxxx",
                    "IPAddress": "192.168.xx.xxx",
                    "NetType": "Private",
                    "VSwitchId": "vsw-bpxxxxxxxx"
                }
            ],
            "Nodes": "pi-bpxxxxxxxx,pi-bpxxxxxxxx",
            "DBEndpointId": "pe-bpxxxxxxxx",
            "EndpointConfig": "{\"DistributedTransaction\":\"off\",\"TrackLSNPerTab\":\"on\",\"ConsistLevel\":\"1\",\"StrictSPCalls\":\"on\",\"CausalConsistRead\":\"1\",\"StrictMultiStmt\":\"on\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}"
        },
        {
            "EndpointType": "Primary",
            "AddressItems": [
                {
                    "Port": "3306",
                    "ConnectionString": "pc-bpxxxxxxxx.mysql.polardb.rds.aliyuncs.com",
                    "VPCId": "vpc-bpxxxxxxxx",
                    "IPAddress": "192.168.xx.xxx",
                    "NetType": "Private",
                    "VSwitchId": "vsw-bpxxxxxxxx"
                }
            ],
            "Nodes": "pi-bpxxxxxxxx",
            "DBEndpointId": "pe-bpxxxxxxxx",
            "EndpointConfig": "{}"
        }
    ],
    "RequestId": "0E6CDE6C-107C-48C0-8995-BA976DF558A2"
}

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。