DescribeDBInstanceNetInfo を使用した SelectDB インスタンスのネットワーク情報クエリ - SelectDB

指定された SelectDB インスタンスのネットワーク情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

selectdb:DescribeDBInstanceNetInfo

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	selectdb-cn-7213cjv****
RegionId	string	必須	リージョン ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。	ADF42B18-43FD-5100-83A9-BE81AB70C863
DBInstanceNetInfos	array<object>	インスタンスのネットワーク情報。
	array<object>	インスタンスのネットワーク情報。
NetType	string	インスタンスのネットワークタイプ。有効な値： VPC：Virtual Private Cloud (VPC) PUBLIC：パブリックネットワーク	VPC
VpcInstanceId	string	VPC インスタンス ID。	selectdb-cn-h033cnd****-fe-20230816101006
VpcId	string	VPC ID。	vpc-wz90scxq6ods388ft****
VswitchId	string	vSwitch ID。	vsw-uf6mlqti065rer6m0****
UserVisible	boolean	エンドポイントがユーザーに表示されるかどうかを示します。有効な値： true：エンドポイントは表示されます。 false：エンドポイントは表示されません。	true
ConnectionString	string	エンドポイント。	selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com
Ip	string	IP アドレス。	172.16.XX.XX
PortList	array<object>	ポートオブジェクト。
	object	ポートの詳細。
Protocol	string	ポートのプロトコルタイプ。有効な値： HttpPort：HTTP プロトコルポート。 MySQLPort：MySQL プロトコルポート。	9030
Port	integer	ポート番号。	MySQLPort
ClusterId	string	クラスター ID。	selectdb-cn-****-be
DBClustersNetInfos	array<object>	BE クラスターのネットワーク情報のリスト。
	array<object>	BE クラスターのネットワーク情報。
NetType	string	ネットワークタイプ。	VPC/PUBLIC
VpcInstanceId	string	VPC インスタンス ID。	selectdb-cn-****-fe-20230816101006
VpcId	string	VPC ID。	vpc-****
VswitchId	string	vSwitch ID。	vsw-****
UserVisible	boolean	エンドポイントがユーザーに表示されるかどうかを示します。	true/false
ConnectionString	string	エンドポイント。	selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com
Ip	string	IP アドレス。	8.131.*.*
PortList	array<object>	ポートのリスト。
	object	ポート情報。
Protocol	string	ポートのプロトコルタイプ。	MySQLPort/HttpPort
Port	integer	ポート番号。	9030/8080
ClusterId	string	クラスター ID。	selectdb-cn-****-be

例

成功レスポンス

JSONJSON

{
  "RequestId": "ADF42B18-43FD-5100-83A9-BE81AB70C863",
  "DBInstanceNetInfos": [
    {
      "NetType": "VPC",
      "VpcInstanceId": "selectdb-cn-h033cnd****-fe-20230816101006",
      "VpcId": "vpc-wz90scxq6ods388ft****",
      "VswitchId": "vsw-uf6mlqti065rer6m0****",
      "UserVisible": true,
      "ConnectionString": "selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com",
      "Ip": "172.16.XX.XX",
      "PortList": [
        {
          "Protocol": "9030",
          "Port": 0
        }
      ],
      "ClusterId": "selectdb-cn-****-be"
    }
  ],
  "DBClustersNetInfos": [
    {
      "NetType": "VPC/PUBLIC",
      "VpcInstanceId": "selectdb-cn-****-fe-20230816101006",
      "VpcId": "vpc-****",
      "VswitchId": "vsw-****",
      "UserVisible": true,
      "ConnectionString": "selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com",
      "Ip": "8.131.***.***",
      "PortList": [
        {
          "Protocol": "MySQLPort/HttpPort",
          "Port": 0
        }
      ],
      "ClusterId": "selectdb-cn-****-be"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	日文说明1
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	日文说明1
400	InvalidDBName	The specified database name is not allowed.	日文说明1
400	CreateOrderFailed	Failed to create order.	注文の作成に失敗しました。
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	日文说明1
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	日文说明1
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	日文说明1
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	日文说明1
403	MoneyLessThan100	The Account Monet less Than 100.	日文说明1
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	日文说明1
403	InsufficientResourceCapacity	The resource is out of usage.	リソースが不足しています。しばらくしてからやり直してください。
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.
404	InvalidClusterInstance.NotFound	Specified cluster instance does not exist.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	日文说明1
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	日文说明1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	日文说明1
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	日文说明1
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	日文说明1
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	日文说明1

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

変更履歴

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