Use DescribeDBNodeDirectVipInfo to query virtual IP addresses of nodes in direct connection mode - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Note

Only instances that use cloud disks support this operation.

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:DescribeDBNodeDirectVipInfo

get

*DBInstance

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABAF95F6-35C1-4177-AF3A-70969EBD****
InstanceId	string	The instance ID.	r-bp1zxszhcgatnx****
DirectVipInfo	object
VipInfo	array<object>	The VIP information of shards in the cluster instance.
	object	The VIP information of a shard in the cluster instance.
NodeId	string	The shard ID.	r-8vb3679b04551444-db-2
Vip	string	The VIP of the shard.	100.115.61.8
Port	string	The port number. Valid values: 1024 to 65535. Default value: 6379.	6379
NetType	string	The network type of the security group. Valid values: vpc: Virtual Private Cloud (VPC)	vpc

Examples

Success response

JSON format

{
  "RequestId": "ABAF95F6-35C1-4177-AF3A-70969EBD****",
  "InstanceId": "r-bp1zxszhcgatnx****",
  "DirectVipInfo": {
    "VipInfo": [
      {
        "NodeId": "r-8vb3679b04551444-db-2",
        "Vip": "100.115.61.8",
        "Port": "6379",
        "NetType": "vpc"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.