DescribeDBInstanceNetInfo API の概要 - AnalyticDB for PostgreSQL

インスタンスの接続情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:DescribeDBInstanceNetInfo

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。説明 DescribeDBInstances 操作を呼び出して、リージョン内のすべての AnalyticDB for PostgreSQL インスタンスに関する情報 (インスタンス ID を含む) を照会できます。	gp-0xin9q82c33xc****
ConnectionString	string	任意	インスタンスへの接続に使用されるエンドポイント。説明このパラメーターを指定しない場合、インスタンスのすべてのエンドポイントに関する情報が返されます。	gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	7565770E-7C45-462D-BA4A-8A5396F2CAD1
DBInstanceNetInfos	object
DBInstanceNetInfo	array<object>	インスタンスの接続情報。
	object
VSwitchId	string	vSwitch ID。複数の ID はカンマ (,) で区切られます。	vsw-0xi4kt4dho2kx79p1****
ConnectionString	string	インスタンスに接続するために使用するエンドポイントです。	gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com
IPType	string	IP アドレスのタイプ。クラシックネットワークのインスタンスの有効な値: 内部とパブリック。仮想プライベートクラウド (VPC) のインスタンスの有効な値: プライベートとパブリック。	Inner
Port	string	ポート番号です。	3432
VpcInstanceId	string	VPC にデプロイされたインスタンスの ID。	vpc-0xi8hbevlbj3bq0co****
VPCId	string	インスタンスの VPC ID です。	vpc-0xi8hbevlbj3bq0co****
IPAddress	string	IP アドレス。	127.0.0.1
AddressType	string	エンドポイントのタイプです。	Primary
InstanceNetworkType	string	インスタンスのネットワークタイプ。有効な値: Classic: クラシックネットワーク。 VPC: VPC。	VPC

例

成功レスポンス

JSONJSON

{
  "RequestId": "7565770E-7C45-462D-BA4A-8A5396F2CAD1",
  "DBInstanceNetInfos": {
    "DBInstanceNetInfo": [
      {
        "VSwitchId": "vsw-0xi4kt4dho2kx79p1****",
        "ConnectionString": "gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com",
        "IPType": "Inner",
        "Port": "3432",
        "VpcInstanceId": "vpc-0xi8hbevlbj3bq0co****",
        "VPCId": "vpc-0xi8hbevlbj3bq0co****",
        "IPAddress": "127.0.0.1",
        "AddressType": "Primary"
      }
    ]
  },
  "InstanceNetworkType": "VPC"
}

エラーコード

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

変更履歴

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