すべてのプロダクト
Search

このプロダクト

    :DescribeDBClusterEndpoints

    ドキュメントセンター

    :DescribeDBClusterEndpoints

    最終更新日:Dec 11, 2025

    PolarDB クラスターのエンドポイント情報を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeDBClusterEndpoints

    get

    *dbcluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含む、アカウント内のすべてのクラスターの詳細を照会できます。

    pc-*************
    DBEndpointId

    string

    任意

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

    pe-*************
    DescribeType

    string

    任意

    AI ノードに関する情報を返すかどうかを指定します。

    AI
    PolarFsInstanceId

    string

    任意

    pfs-test*****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    array<object>

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

    array<object>

    Nodes

    string

    エンドポイントに設定されているノードのリスト。

    pi-***************,pi-***************
    ReadWriteMode

    string

    読み書きモード。有効な値：

    • ReadWrite：読み書き (自動読み書き分離)。

    • ReadOnly：読み取り専用。

    ReadOnly
    AddressItems

    array<object>

    接続文字列に関する情報。

    object

    VSwitchId

    string

    vSwitch の ID。

    vsw-************
    PrivateZoneConnectionString

    string

    エンドポイントにバインドされているプライベートドメイン名。

    ***.***.**.com
    ConnectionString

    string

    接続文字列。

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

    string

    ネットワークタイプ。有効な値：

    • Public：パブリックネットワーク

    • Private：プライベートネットワーク

    Private
    Port

    string

    ポート。

    1521
    VpcInstanceId

    string

    VPC インスタンスの ID。

    説明

    このパラメーターは、PolarDB for MySQL クラスターの場合にのみ返されます。

    pe-*************
    VPCId

    string

    VPC の ID。

    vpc-***************
    IPAddress

    string

    IP アドレス。

    192.***.***.***
    DashboardUsed

    boolean

    エンドポイントが PolarDB 検索ノードのダッシュボードエンドポイントであるかどうかを示します。

    • True：はい

    • False：いいえ

    True
    DBEndpointId

    string

    エンドポイントの ID。

    pe-*************
    EndpointConfig

    string

    クラスターエンドポイントの詳細設定。

    • DistributedTransaction：トランザクション分割のステータス。有効な値：

      • on：有効

      • off：無効

    • ConsistLevel：セッションの一貫性レベル。有効な値：

      • 0：最終的な整合性

      • 1：セッションの一貫性

      • 2：グローバル整合性

    • LoadBalanceStrategy：負荷分散ポリシー。値は load に固定されており、負荷ベースのスケジューリングを示します。

    • MasterAcceptReads：プライマリノードが読み取りリクエストを受け入れるかどうかを指定します。有効な値：

      • on：プライマリノードは読み取りリクエストを受け入れます。

      • off：プライマリノードは読み取りリクエストを受け入れません。

    {\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
    DBEndpointDescription

    string

    エンドポイントの名前。

    test
    EndpointType

    string

    クラスターエンドポイントのタイプ。有効な値：

    • Cluster：デフォルトのクラスターエンドポイント。

    • Primary：プライマリエンドポイント。

    • Custom：カスタムクラスターエンドポイント。

    Custom
    AutoAddNewNodes

    string

    新しいノードがデフォルトのクラスターエンドポイントに自動的に追加されるかどうかを示します。有効な値：

    • Enable

    • Disable

    Enable
    DBClusterId

    string

    クラスター ID。

    pc-bp1s826a1up******
    SccMode

    string

    ノードでグローバル整合性 (パフォーマンス専有型モード) が有効になっているかどうかを示します。有効な値：

    • on：有効

    • off：無効

    on
    PolarSccTimeoutAction

    string

    グローバル整合性の読み取りタイムアウトを処理するためのポリシー。有効な値：

    • 0：リクエストをプライマリノードに送信します。

    • 2：リクエストをダウングレードします。グローバル整合性の読み取りがタイムアウトした場合、クエリは自動的に通常のリクエストにダウングレードされ、クライアントはエラーメッセージを受信しません。

    0
    PolarSccWaitTimeout

    string

    グローバル整合性のタイムアウト。

    100
    NodeWithRoles

    string

    エンドポイント内の各ノードのロール。プライマリノードのロールは Writer です。複数の読み取り専用ノードをエンドポイントに追加できるため、各読み取り専用ノードのロールは、Reader1、Reader2 などの番号で区別されます。

    説明

    このパラメーターは、PolarDB for PostgreSQL クラスターおよび PolarDB for PostgreSQL (Oracle 互換) クラスターでのみサポートされます。

    Reader1

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。