DescribeDBInstanceNetInfo - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

ApsaraDB for Tair インスタンスのネットワーク情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeDBInstanceNetInfo

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。	r-bp1zxszhcgatnx****
NetType	string	任意	ネットワークタイプ。

レスポンスフィールド

フィールド	型	説明	例
	object
InstanceNetworkType	string	ネットワークタイプ。有効な値は以下のとおりです。 CLASSIC: クラシックネットワーク。 VPC: VPC。	CLASSIC
RequestId	string	リクエスト ID。	FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B
NetInfoItems	object	インスタンスのネットワーク接続に関する詳細情報。
InstanceNetInfo	array<object>	インスタンスのネットワーク接続詳細を格納した配列。
	object	ネットワーク接続の詳細情報。
DirectConnection	integer	アドレスがダイレクト接続用かどうかを示します。有効な値は以下のとおりです。 0: ダイレクト接続用ではないアドレス。 1: ダイレクト接続用のアドレス。	0
VSwitchId	string	vSwitch の ID。	vsw-bp1e7clcw529l773d****
DBInstanceNetType	string	ネットワークタイプ。有効な値は以下のとおりです。 0: パブリックネットワーク。 1: クラシックネットワーク。 2: VPC ネットワーク。	1
Upgradeable	string	クラシックネットワーク接続文字列の残り有効期間（秒単位）。説明値が 0 の場合、接続文字列に有効期限はありません。	0
ExpiredTime	string	クラシックネットワーク接続文字列の有効期間（秒単位）。	5183778
ConnectionString	string	インスタンスの接続文字列。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
IPType	string	IP アドレスのネットワークタイプ。有効な値は以下のとおりです。 Public: パブリックネットワーク。 Inner: クラシックネットワーク。 Private: VPC ネットワーク。	Inner
VPCInstanceId	string	VPC に関連付けられたインスタンスの ID。	r-bp1ky7j6qc7umk****
Port	string	インスタンスのサービスポート。	6379
VPCId	string	インスタンスが属する VPC の ID。	vpc-bp1nme44gek34slfc****
IPAddress	string	IP アドレス。	172.16.49.***
IsSlaveProxy	integer	値が 1 の場合、このネットワークアドレスはスタンバイゾーン内のレプリカノード用です。説明このアドレスは、インスタンスでマルチゾーン読み書き分離が有効になっている場合にのみ返されます。	1

例

成功レスポンス

JSONJSON

{
  "InstanceNetworkType": "CLASSIC",
  "RequestId": "FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B",
  "NetInfoItems": {
    "InstanceNetInfo": [
      {
        "DirectConnection": 0,
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "DBInstanceNetType": "1",
        "Upgradeable": "0",
        "ExpiredTime": "5183778",
        "ConnectionString": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "IPType": "Inner",
        "VPCInstanceId": "r-bp1ky7j6qc7umk****",
        "Port": "6379",
        "VPCId": "vpc-bp1nme44gek34slfc****",
        "IPAddress": "172.16.49.***",
        "IsSlaveProxy": 1
      }
    ]
  }
}

エラーレスポンス

JSONJSON

{
 "RequestId":"314C4FB3-4256-424F-9AD9-1A6B3444160A",
 "InstanceNetworkType":"Classic",
 "NetInfoItems":{
   "InstanceNetInfo":[{
     "DBInstanceNetType":"1",
     "Port":"6379",
     "ConnectionString":"r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com",
     "VPCId":"",
     "IPAddress":"xxx.xxx.xxx.xxx",
     "IPType":"Inner",
     "Upgradeable":"0"
   				   }]
   			 }
}

エラーコード

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

変更履歴

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