DescribeDbInstanceConnectivity - Tair (Redis® OSS-Compatible)

Checks the connectivity between the client IP address and the instance.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeDbInstanceConnectivity	get	*DBInstance `acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	r-bp1r36hdqlrgt1****
SrcIp	string	Yes	The IP address of the client.	124.207.240.***

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	2BE6E619-A657-42E3-AD2D-18F8428A****
ConnCheckResult	string	The connection check result. Valid values: Success Failed	Failed
ConnCheckErrorCode	string	The error code for connection diagnosis. Valid values: SRC_IP_NOT_IN_USER_WHITELIST: The source IP address is not added to the whitelist. CONNECTION_ABNORMAL: The connection to the instance is normal.	SRC_IP_NOT_IN_USER_WHITELIST
ConnCheckErrorMessage	string	The error message for connection diagnosis.	Src ip:172.28.134.96 not in user whitelist

Examples

Sample success responses

JSONformat

{
  "RequestId": "2BE6E619-A657-42E3-AD2D-18F8428A****",
  "ConnCheckResult": "Failed",
  "ConnCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
  "ConnCheckErrorMessage": "Src ip:172.28.134.96 not in user whitelist"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-10-27	Add Operation	View Change Details