调用DescribeDBInstanceNetInfo查看Redis实例的网络信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceNetInfo

系统规定参数,取值:DescribeDBInstanceNetInfo

InstanceId String r-bp1zxszhcgatnx****

实例ID。

RegionId String cn-hangzhou

实例所属的地域ID。

返回数据

名称 类型 示例值 描述
InstanceNetworkType String CLASSIC

网络类型,返回值:

  • CLASSIC:经典网络。
  • VPC:专有网络。
NetInfoItems Array of InstanceNetInfo

实例的网络信息列表。

InstanceNetInfo
ConnectionString String r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

实例的连接地址。

DBInstanceNetType String 1

该网络信息所属的网络类型:

  • 0:公网。
  • 1:经典网络。
  • 2:专有网络。
DirectConnection Integer 0

是否为直连地址,返回值:

  • 0:非直连地址。
  • 1:直连地址。
ExpiredTime String 5183779

Redis实例经典网络地址的有效时间,单位:秒。

IPAddress String 172.16.49.***

IP地址。

IPType String Inner

IP地址的网络类型,返回值:

  • Public:公网。
  • Inner:经典网络。
  • Private:VPC网络。
Port String 6379

Redis服务端口。

Upgradeable String 0

经典网络连接地址的过期时间,即剩余有效时间,单位为秒。

说明 0表示不会过期。
VPCId String vpc-bp1nme44gek34slfc****

实例所属的专有网络(VPC)的ID。

VPCInstanceId String r-bp1ky7j6qc7umk****

实例ID。

VSwitchId String vsw-bp1e7clcw529l773d****

虚拟交换机的ID。

RequestId String FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribeDBInstanceNetInfo
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDBInstanceNetInfoResponse>
  <NetInfoItems>
        <InstanceNetInfo>
              <IPType>Private</IPType>
              <VPCInstanceId>r-bp1ky7j6qc7umk****</VPCInstanceId>
              <VPCId>vpc-bp1opxu1zkhn00gzv****</VPCId>
              <DBInstanceNetType>2</DBInstanceNetType>
              <Port>6379</Port>
              <DirectConnection>0</DirectConnection>
              <Upgradeable>0</Upgradeable>
              <ConnectionString>r-bp1ky7j6qc7umk****.redis.rds.aliyuncs.com</ConnectionString>
              <IPAddress>172.16.49.***</IPAddress>
        </InstanceNetInfo>
  </NetInfoItems>
  <RequestId>500F0FD3-5065-4A1D-A27C-BBC567956068</RequestId>
  <InstanceNetworkType>VPC</InstanceNetworkType>
</DescribeDBInstanceNetInfoResponse>

JSON 格式

{
	"NetInfoItems": {
		"InstanceNetInfo": [
			{
				"IPType": "Private",
				"VPCInstanceId": "r-bp1ky7j6qc7umk****",
				"VPCId": "vpc-bp1opxu1zkhn00gzv****",
				"DBInstanceNetType": "2",
				"Port": "6379",
				"DirectConnection": 0,
				"Upgradeable": "0",
				"ConnectionString": "r-bp1ky7j6qc7umk****.redis.rds.aliyuncs.com",
				"IPAddress": "172.16.49.***"
			}
		]
	},
	"RequestId": "500F0FD3-5065-4A1D-A27C-BBC567956068",
	"InstanceNetworkType": "VPC"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid. 结束时间验证失败,时间格式应该为gmt时间例如2011-06-11T16:00Z

访问错误中心查看更多错误码。