Query instance network information using DescribeDBInstanceNetInfo - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the network information of an ApsaraDB for Tair instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeDBInstanceNetInfo

get

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
NetType	string	No	The network type.

Response elements

Element	Type	Description	Example
	object
InstanceNetworkType	string	The network type. Valid values: CLASSIC: Classic Network. VPC: VPC.	CLASSIC
RequestId	string	The request ID.	FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B
NetInfoItems	object	Details about the instance's network connections.
InstanceNetInfo	array<object>	An array of network connection details for the instance.
	object	The details of a network connection.
DirectConnection	integer	Indicates whether the address is for a direct connection. Valid values: 0: The address is not for a direct connection. 1: The address is for a direct connection.	0
VSwitchId	string	The ID of the vSwitch.	vsw-bp1e7clcw529l773d****
DBInstanceNetType	string	The network type. Valid values: 0: public network. 1: Classic Network. 2: VPC network.	1
Upgradeable	string	The remaining validity period of the Classic Network connection string, in seconds. Note A value of 0 indicates that the connection string does not expire.	0
ExpiredTime	string	The validity period of the Classic Network connection string, in seconds.	5183778
ConnectionString	string	The connection string of the instance.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
IPType	string	The network type of the IP address. Valid values: Public: public network. Inner: Classic Network. Private: VPC network.	Inner
VPCInstanceId	string	The ID of the instance associated with the VPC.	r-bp1ky7j6qc7umk****
Port	string	The service port of the instance.	6379
VPCId	string	The ID of the VPC to which the instance belongs.	vpc-bp1nme44gek34slfc****
IPAddress	string	The IP address.	172.16.49.***
IsSlaveProxy	integer	A value of 1 indicates that this network address is for a replica node in the standby zone. Note This address is returned only when multi-zone read/write splitting is enabled for the instance.	1

Examples

Success response

JSON format

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

Error response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.