DescribeSecurityIps - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Queries the IP address whitelists of an ApsaraDB for Redis 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:DescribeSecurityIps	get	*DBInstance `acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}`	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	EFC9161F-15E3-4A6E-8A99-C09916D1****
SecurityIpGroups	array<object>	The whitelists of the instance.
SecurityIpGroup	object
SecurityIpGroupAttribute	string	The attribute of the whitelist. This parameter is empty by default. Note If the instance is authorized to use a service such as Database Autonomy Service (DAS), Data Management (DMS), or Data Transmission Service (DTS), this service automatically generates a hidden whitelist for the instance. This type of whitelists cannot be modified or deleted.	hidden
SecurityIpList	string	The IP addresses in the whitelist. A maximum of 1,000 IP addresses can be specified in a whitelist.	100.100.202.*/24,10.10.10.*
SecurityIpGroupName	string	The name of the whitelist.	default

Examples

Sample success responses

JSONformat

{
  "RequestId": "EFC9161F-15E3-4A6E-8A99-C09916D1****",
  "SecurityIpGroups": {
    "SecurityIpGroup": [
      {
        "SecurityIpGroupAttribute": "hidden",
        "SecurityIpList": "100.100.202.***/24,10.10.10.***",
        "SecurityIpGroupName": "default"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.	The instance does not exist in our record. You can call the DescribeInstances interface to view the instance information under the current user.

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

Change history

Change time	Summary of changes	Operation
2025-03-25	API Description Update. The Error code has changed	View Change Details
2023-08-16	The Error code has changed	View Change Details