All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeDBNodeDirectVipInfo

Last Updated:Dec 19, 2024

Queries the information about virtual IP addresses (VIPs) of child instances of a cluster instance in direct connection mode.

Operation description

Note Only instances that use cloud disks support this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeDBNodeDirectVipInfoget
*DBInstance
acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

r-bp1zxszhcgatnx****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

ABAF95F6-35C1-4177-AF3A-70969EBD****
InstanceIdstring

The instance ID.

r-bp1zxszhcgatnx****
DirectVipInfoarray<object>

The virtual IP addresses (VIPs) of shards in an ApsaraDB for Redis cluster instance.

VipInfoobject
NodeIdstring

The shard ID.

r-8vb3679b04551444-db-2
Vipstring

The VIP of the shard.

100.115.61.8
Portstring

The port number. Valid values: 1024 to 65535. Default value: 6379.

6379
NetTypestring

The network type of the security group. Valid values:

  • vpc: Virtual Private Cloud (VPC)
vpc

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history