調用DescribeDBInstanceNetInfo介面查看執行個體的所有串連地址資訊。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String 是 DescribeDBInstanceNetInfo

系統規定參數，取值：DescribeDBInstanceNetInfo。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

執行個體ID。
DBInstanceNetRWSplitType String 否 Normal

串連地址類型，取值：

  • Normal：普通串連地址；
  • ReadWriteSplitting：讀寫分離串連地址。
说明 預設返回所有類型串連地址。
AccessKeyId String 否 LTAIfCxxxxxxx

阿里雲頒發給使用者的訪問服務所用的密鑰ID。
ClientToken String 否 ETnLKlblzczshOTUbOCzxxxxxxxxxx

用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過64個ASCII字元，且該參數值中不能包含非ASCII字元。
Flag String 否 -

備用參數。

返回資料

名稱 類型 樣本值 描述
DBInstanceNetInfos

執行個體的串連地址資訊列表。
ConnectionString String rm-uf6wxxxxx.mysql.rds.aliyuncs.com

串連地址。
IPAddress String 192.168.12.84

IP地址。
IPType String Public

網路類型。

  • 傳統網路類型取值：
    • Inner：內網；
    • Public：外網。
  • VPC類型取值：
    • Private：內網；
    • Public：外網。
Port String 3306

串連連接埠。
VPCId String vpc-uf6f7l4fg90xxxxxxxxxx

VPC ID。
VSwitchId String vsw-uf6adz52c2pxxxxxxxxxx

交換器ID。
ConnectionStringType String Normal

串連地址類型，取值：

  • Normal：普通串連地址；
  • ReadWriteSplitting：讀寫分離串連地址。
MaxDelayTime String 12

延遲閾值，只在讀寫分離串連地址返回該參數，單位：秒。

说明 超過該延遲閾值的唯讀執行個體不會被分配流量。
DistributionType String Standard

讀請求分配策略，只在讀寫分離串連地址返回該參數，取值：

  • Standard：按規格權重自動分配；
  • Custom：自訂分配權重。
DBInstanceWeights

執行個體權重資訊列表，開通了讀寫分離地址的執行個體會返回該參數。
DBInstanceId String rm-uf6wjk5xxxxxxx

執行個體ID。
DBInstanceType String Master

執行個體類型，取值：

  • Master：主執行個體；
  • Readonly：唯讀執行個體。
Weight String 100

執行個體當前權重。
Availability String Unavailable

執行個體可用狀態，取值：

  • Unavailable：不可用；
  • Available：可用。
ExpiredTime String 1209534

混訪模式下，傳統網路的剩餘時間，單位：秒。
SecurityIPGroups

執行個體的IP白名單分組列表。
SecurityIPGroupName String Default

IP白名單分組名稱。
SecurityIPs String 127.0.0.1

白名單IP。
Upgradeable String Disabled

IP版本是否能夠升級，取值：true | false

说明 IPv4版本可以升級到IPv6版本。
InstanceNetworkType String VPC

網路類型，取值：

  • Classic：傳統網路；
  • VPC：專用網路。
RequestId String 777C4593-8053-427B-99E2-105593277CAB

請求ID。
SecurityIPMode String safety

白名單模式，取值：

  • normal：通用模式；
  • safety：高安全模式。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceNetInfo
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公用請求參數>

正常返回樣本

XML 格式 

<DescribeDBInstanceNetInfoResponse>
	  <dBInstanceNetInfos>
		    <connectionString>rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com</connectionString>
		    <connectionStringType>Normal</connectionStringType>
		    <iPAddress>192.168.xx.xx</iPAddress>
		    <iPType>Public</iPType>
		    <port>3306</port>
		    <upgradeable>Disabled</upgradeable>
		    <vPCId></vPCId>
	  </dBInstanceNetInfos>
	  <instanceNetworkType>Classic</instanceNetworkType>
	  <requestId>777C4593-8053-427B-99E2-105593277CAB</requestId>
</DescribeDBInstanceNetInfoResponse>

JSON 格式 

{
	"instanceNetworkType":"Classic",
	"requestId":"777C4593-8053-427B-99E2-105593277CAB",
	"dBInstanceNetInfos":[
		{
			"port":"3306",
			"dBInstanceWeights":[],
			"iPType":"Public",
			"connectionStringType":"Normal",
			"vPCId":"",
			"securityIPGroups":[],
			"connectionString":"rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com",
			"iPAddress":"192.168.xx.xx",
			"upgradeable":"Disabled"
		}
	]
}

錯誤碼

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