すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeDBClusterEndpointsZonal

    ドキュメントセンター

    PolarDB:DescribeDBClusterEndpointsZonal

    最終更新日:Dec 12, 2025

    PolarDB on ENS のエッジクラスターのエンドポイントを照会します。

    今すぐお試しください

    この 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:DescribeDBClusterEndpointsZonal

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    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：リクエストをプライマリノードに送信します。

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

    0
    DBClusterId

    string

    クラスター ID。

    pc-bp1s826a1up******
    Nodes

    string

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

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

    string

    読み書きモード。有効な値は次のとおりです：

    • ReadWrite：読み取りと書き込み (自動読み書き分離)。

    • ReadOnly：読み取り専用。

    ReadOnly
    DBEndpointDescription

    string

    エンドポイントの名前。

    test
    PolarSccWaitTimeout

    string

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

    100
    NodeWithRoles

    string

    エンドポイントにおける各ノードのロール。プライマリノードは Writer ロールです。エンドポイントには複数の読み取り専用ノードを追加できるため、各読み取り専用ノードには `Reader1`、`Reader2` のように、末尾に番号が付加されたロール名が割り当てられます。

    Reader1
    AutoAddNewNodes

    string

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

    • Enable

    • Disable

    Enable
    EndpointType

    string

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

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

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

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

    Custom
    AddressItems

    array<object>

    接続文字列の情報。

    object

    DashboardUsed

    boolean

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

    • True：はい。

    • False：いいえ。

    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

    ネットワークタイプ。 有効な値は次のとおりです：

    • Public：インターネット。

    • Private：内部ネットワーク。

    Private
    SccMode

    string

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

    • on：有効。

    • off：無効。

    on
    EndpointConfig

    string

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

    • DistributedTransaction：トランザクション分割のステータス。 有効な値は次のとおりです。

      • on：トランザクション分割は有効です。

      • off：トランザクション分割は無効です。

    • ConsistLevel：整合性レベル。 有効な値は次のとおりです。

      • 0：結果整合性。

      • 1：セッション整合性。

      • 2：グローバル整合性。

    • LoadBalanceStrategy：負荷に基づく自動スケジューリングのための負荷分散ポリシー。 値は load に固定されています。

    • MasterAcceptReads：プライマリノードが読み取りリクエストを受け入れるかどうか。 有効な値は次のとおりです。

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

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

    {\"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.
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.

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

    変更履歴

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