DescribeDBInstanceNetInfo - 查看執行個體的網路資訊 - Tair (Redis® OSS-Compatible)

查看雲資料庫 Tair（相容 Redis）執行個體的網路資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeDBInstanceNetInfo

get

*DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	r-bp1zxszhcgatnx****
NetType	string	否

返回參數

名稱	類型	描述	樣本值
	object
InstanceNetworkType	string	網路類型，傳回值： CLASSIC：傳統網路。 VPC：專用網路。	CLASSIC
RequestId	string	請求 ID。	FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B
NetInfoItems	object
InstanceNetInfo	array<object>	執行個體的網路資訊列表。
	object	執行個體的網路資訊列表。
DirectConnection	integer	是否為直連地址，傳回值： 0：非直連地址。 1：直連地址。	0
VSwitchId	string	虛擬交換器的 ID。	vsw-bp1e7clcw529l773d****
DBInstanceNetType	string	該網路資訊所屬的網路類型： 0：公網。 1：傳統網路。 2：專用網路。	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	執行個體 ID。	r-bp1ky7j6qc7umk****
Port	string	執行個體的服務連接埠。	6379
VPCId	string	執行個體所屬的Virtual Private Cloud的 ID。	vpc-bp1nme44gek34slfc****
IPAddress	string	IP 位址。	172.16.49.***
IsSlaveProxy	integer	表示該地址為備可用性區域的串連地址，取值為 1，表示備可用性區域。說明該地址僅在開通多可用性區域讀寫分離架構後返回。	1

樣本

正常返回樣本

JSON格式

{
  "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
      }
    ]
  }
}

異常返回樣本

JSON格式

{
 "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"
   				   }]
   			 }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。