DB クラスター 네트워크 엔드포인트詳細概要 - 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:DescribeDBClusterNetInfo

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-****************
ConnectionStringType	string	任意	エンドポイントのタイプ。有効な値: Normal: プライマリエンドポイント ReadWriteSplitting: クラスターエンドポイント MPP: Massively Parallel Processing (MPP) エンドポイント	Normal

レスポンスフィールド

フィールド	型	説明	例
	object	クラスターエンドポイントに関する情報。
DBClusterNetInfos	object
DBClusterNetInfo	array<object>	クラスターエンドポイントに関する情報。
	object	クラスターエンドポイントに関する情報。
VSwitchId	string	vSwitch の ID。	vsw-bp1li3eavsz8oaexq15dw
ConnectionStringType	string	エンドポイントのタイプ。有効な値: Normal: プライマリエンドポイント ReadWriteSplitting: クラスターエンドポイント MPP: MPP エンドポイント	MPP
ConnectionString	string	データベースエンドポイント。	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	IP アドレスのネットワークタイプ。有効な値: Public: インターネット。 Inner: クラシックネットワーク。 Private: VPC。	Public
Port	string	ポート番号。	1521
VPCId	string	VPC の ID。	vpc-***************
IPAddress	string	IP アドレス。	121...173
ClusterNetworkType	string	クラスターのネットワークタイプ。値は VPC に固定されています。	VPC
RequestId	string	リクエスト ID。	72D99256-ACF1-5F86-831F-8CB53E9C23ED
DBNodeNetInfos	object
DBNodeNetInfo	array<object>	ノードエンドポイントに関する情報。
	array<object>	ノードエンドポイントに関する情報。
NetInfos	object
NetInfo	array<object>	ノードエンドポイントに関する情報。
	object	ノードエンドポイントに関する情報。
VSwitchId	string	vSwitch の ID。	vsw-*************
ConnectionString	string	データベースエンドポイント。	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	IP アドレスのネットワークタイプ。有効な値: Public: インターネット。 Inner: クラシックネットワーク。 Private: VPC。	Public
Port	string	ポート番号。	5432
VPCId	string	VPC の ID。	vpc-****************
IPAddress	string	IP アドレス。	47...203
DBNodeRole	string	ノードのロール。有効な値: Writer: プライマリノード。 Reader: 読み取り専用ノード。 ColumnReader: 列ストア読み取り専用ノード。 AI: AI ノード。	Writer
DBInstanceId	string	インスタンス ID。	pc-*************

例

成功レスポンス

JSONJSON

{
  "DBClusterNetInfos": {
    "DBClusterNetInfo": [
      {
        "VSwitchId": "vsw-bp1li3eavsz8oaexq15dw",
        "ConnectionStringType": "MPP",
        "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com",
        "IPType": "Public",
        "Port": "1521",
        "VPCId": "vpc-***************",
        "IPAddress": "121.*.*.173"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "72D99256-ACF1-5F86-831F-8CB53E9C23ED",
  "DBNodeNetInfos": {
    "DBNodeNetInfo": [
      {
        "NetInfos": {
          "NetInfo": [
            {
              "VSwitchId": "vsw-*************",
              "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com\n",
              "IPType": "Public",
              "Port": "5432",
              "VPCId": "vpc-****************",
              "IPAddress": "47.*.*.203"
            }
          ]
        },
        "DBNodeRole": "Writer",
        "DBInstanceId": "pc-*************"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

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

変更履歴

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