すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeDBInstanceEndpoint

    ドキュメントセンター

    PolarDB:DescribeDBInstanceEndpoint

    最終更新日:Sep 10, 2026

    カスタムエンドポイントを照会します。

    操作説明

    ユーザーが設定したカスタムエンドポイントのリストを照会します。これにより、非公開接続または VPC エンドポイントサービスの設定を管理および確認できます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardbx:DescribeDBInstanceEndpoint

    list

    *PolarDBXInstance。

    acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    インスタンスが存在するリージョン。

    cn-hangzhou
    DBInstanceName

    string

    必須

    インスタンス ID。

    pxc-hzjasd****
    MaxResults

    integer

    任意

    ページングクエリの 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 値が指定されていないか、10 未満の場合、デフォルト値は 10 です。値が 100 を超える場合、デフォルト値は 100 です。

    1000
    NextToken

    string

    任意

    次のクエリのトークン。

    xxdds

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    A501A191-BD70-5E50-98A9-C2A486A82****
    Data

    object

    モニタリングデータ。

    Items

    array<object>

    内部接続タイプ。値は 1 に固定されており、クラシックネットワークを示します。

    array<object>

    ノード情報。

    Endpoint

    object

    インスタンスのエンドポイント。

    Address

    string

    アドレス。

    10.21.1.82
    Class

    string

    インスタンスのスペックタイプ (スペックコード)。

    mdb.shard.4x.large.d。
    EndpointGroupId

    integer

    エンドポイントが属するエンドポイントグループの ID。

    epg-bp14wgzai7flglwdtkxfa。
    Id

    integer

    論理ノードの ID。

    2899
    Kind

    string

    ペイロードタイプ: agentTurn (エージェント会話) または systemEvent (システムイベント)。

    インスタンス
    NetType

    string

    エンドポイントのネットワークタイプ。有効な値:

    • Public: パブリックエンドポイント。

    • Private: プライベートエンドポイント。

    • Inner: プライベートエンドポイント (クラシックネットワーク)。

    VPC。
    TargetName

    string

    オブジェクト名。

    sas-app。
    TunnelId

    integer

    トンネル ID。

    3522367
    Type

    string

    インスタンスタイプ。有効な値:

    • ReadWrite: プライマリインスタンス。

    • ReadOnly: 読み取り専用インスタンス。

    TXT。
    UserVisible

    boolean

    エンドポイントがユーザーに表示されるかどうかを示します。

    Vip

    string

    ポリシーによって保護されている Anti-DDoS 攻撃 プロ版 または Anti-DDoS Premium インスタンスの IP アドレス。

    http://100.100.100.200/latest/meta-data。
    VpcId

    string

    エンドポイントが存在する VPC の ID。

    vpc-bp1s9j8s4h4uqejp9k2z3
    Vport

    integer

    VIP ポート (80、8080、443 など)。

    ポート
    ZoneId

    string

    ゾーン ID。

    `curl uUys2ThR.popscan.xaliyun.com`
    VSwitchId

    string

    vSwitch の ID。

    vsw-2ze51hh6s8tsjgy19g5eu。
    ReadType

    string

    読み書きタイプ。有効な値: ReadWrite (ローストアの読み書き)、ColumnarRead (列のストアの読み取り専用)。

    0
    IsDefault

    boolean

    これがデフォルト vSwitch であるかどうかを示します。

    True。
    RealServer

    array<object>

    オリジンサーバーのアドレス。

    object

    オリジンサーバーのアドレス。

    Activated

    boolean

    ノードが有効かどうかを示します。コンピューティングレイヤーでは、プライマリゾーンのノードのみが有効です。プライマリ/セカンダリのスイッチオーバー後、スタンバイのコンピューティングノードがプライマリノードになります。ストレージレイヤーのすべてのノードは有効です。

    False。
    Class

    string

    インスタンスのスペックタイプ (スペックコード)。

    dds.cs.mid。
    Ip

    string

    IP アドレス。

    172.29.32.166
    Port

    string

    ポート番号。

    3306
    ReplicaId

    integer

    レプリカ ID。

    Node ID.
    Weight

    integer

    送信先ルートの重み。

    • IPsec-VPN 接続のデュアルトンネルモードをサポートする VPN ゲートウェイインスタンスの場合、送信先ルートの重みはデフォルトで 100 であり、実質的な意味はありません。

    • IPsec-VPN 接続のシングルトンネルモードをサポートする VPN ゲートウェイインスタンスの場合、重みは送信先ルートの優先度を表します。

      • 100: 高優先度。同じ送信先 CIDR ブロックを持つ複数の送信先ルートが存在する場合、このルートに関連付けられた IPsec-VPN 接続がアクティブなリンクとして機能します。

      • 0: 低優先度。同じ送信先 CIDR ブロックを持つ複数の送信先ルートが存在する場合、このルートに関連付けられた IPsec-VPN 接続がスタンバイリンクとして機能します。

    255
    NextToken

    string

    次のクエリのトークン。

    xxdds
    MaxResults

    integer

    ページングクエリの 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 値が指定されていないか、10 未満の場合、デフォルト値は 10 です。値が 100 を超える場合、デフォルト値は 100 です。

    1000

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "Items": [
      {
        "Endpoint": {
          "Address": "10.21.1.82",
          "Class": "mdb.shard.4x.large.d。",
          "EndpointGroupId": 0,
          "Id": 2899,
          "Kind": "インスタンス",
          "NetType": "VPC。",
          "TargetName": "sas-app。",
          "TunnelId": 3522367,
          "Type": "TXT。",
          "UserVisible": false,
          "Vip": "http://100.100.100.200/latest/meta-data。",
          "VpcId": "vpc-bp1s9j8s4h4uqejp9k2z3",
          "Vport": 0,
          "ZoneId": "`curl uUys2ThR.popscan.xaliyun.com`",
          "VSwitchId": "vsw-2ze51hh6s8tsjgy19g5eu。",
          "ReadType": "0",
          "IsDefault": true
        },
        "RealServer": [
          {
            "Activated": true,
            "Class": "dds.cs.mid。",
            "Ip": "172.29.32.166",
            "Port": "3306",
            "ReplicaId": 0,
            "Weight": 255
          }
        ]
      }
    ]
  },
  "NextToken": "xxdds。",
  "MaxResults": 1000
}

    エラーコード

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

    変更履歴

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