DescribeDBClusterNetInfo を呼び出してクラスターのネットワーク情報を取得 - AnalyticDB

DescribeDBClusterNetInfo API を呼び出して、ADB クラスターのネットワーク情報を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeDBClusterNetInfo

get

DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	am-bp1xxxxxxxx47
RegionId	string	任意	クラスターが配置されているリージョン ID。	cn-hangzhou
Engine	string	任意	データベースエンジン。	AnalyticDB

レスポンスフィールド

フィールド	型	説明	例
	object
ClusterNetworkType	string	クラスターのネットワークタイプ。	VPC
RequestId	string	リクエスト ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	object
Address	array<object>	クラスターのリスト。
	object
VSwitchId	string	vSwitch ID。説明 NetType が Public の場合、vSwitch ID は空になります。	vsw-xxxxxx
ConnectionString	string	クラスターのエンドポイント。	am-bpxxxxxxxx.ads.aliyuncs.com
NetType	string	ネットワークタイプ。有効な値： Public：パブリックネットワーク。 VPC：VPC。	VPC
Port	string	クラスターの接続ポート。	3306
VPCId	string	VPC ID。説明 NetType が Public の場合、VPC ID は空になります。	vpc-xxxxxxxxx
IPAddress	string	IP アドレス。	192.168.x.x
ConnectionStringPrefix	string	クラスターのエンドポイントプレフィックス。	am-bpxxxxxxxx89k51380

例

成功レスポンス

JSONJSON

{
  "ClusterNetworkType": "VPC",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "Address": [
      {
        "VSwitchId": "vsw-xxxxxx",
        "ConnectionString": "am-bpxxxxxxxx.ads.aliyuncs.com",
        "NetType": "VPC",
        "Port": "3306",
        "VPCId": "vpc-xxxxxxxxx",
        "IPAddress": "192.168.x.x",
        "ConnectionStringPrefix": "am-bpxxxxxxxx89k51380"
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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