Queries the network information about an ApsaraDB for Redis instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDBInstanceNetInfo |
The operation that you want to perform. Set the value to DescribeDBInstanceNetInfo. |
InstanceId | String | Yes | r-bp1zxszhcgatnx**** |
The ID of the instance. |
RegionId | String | No | cn-hangzhou |
The ID of the region where the instance is deployed. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
InstanceNetworkType | String | CLASSIC |
The network type. Valid values:
|
NetInfoItems | Array of InstanceNetInfo |
The list of network information about the instance. |
|
InstanceNetInfo | |||
ConnectionString | String | r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
The endpoint of the instance. |
DBInstanceNetType | String | 1 |
The network type of the endpoint. Valid values:
|
DirectConnection | Integer | 0 |
Indicates whether the address is a private endpoint. Valid values:
|
ExpiredTime | String | 5183779 |
The expiration time of the classic network address of an ApsaraDB for Redis instance. Unit: seconds. |
IPAddress | String | 172.16.49.*** |
The IP address. |
IPType | String | Inner |
The network type of the IP address. Valid values:
|
Port | String | 6379 |
The service port of the ApsaraDB for Redis instance. |
Upgradeable | String | 0 |
The remaining validity period of the endpoint of the classic network. Unit: seconds. Note A value of 0 indicates that the endpoint never expires.
|
VPCId | String | vpc-bp1nme44gek34slfc**** |
The ID of the VPC where the instance is deployed. |
VPCInstanceId | String | r-bp1ky7j6qc7umk**** |
The ID of the instance. |
VSwitchId | String | vsw-bp1e7clcw529l773d**** |
The ID of the vSwitch. |
RequestId | String | FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B |
The ID of the request. |
Examples
Sample requests
https://r-kvstore.aliyuncs.com/?Action=DescribeDBInstanceNetInfo
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | The error message returned because the format of the end time is invalid. The time must be in GMT. Example: 2011-06-11T16:00Z. |
For a list of error codes, visit the API Error Center.