You can call this operation to query the IP address whitelist of an ApsaraDB for Redis instance.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSecurityIps

The operation that you want to perform. Set this parameter to DescribeSecurityIps.

InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance for which you want to query the IP address whitelist.

AccessKeyId String No Lxxxxxxxxxxxxxxw

The AccessKey ID that Alibaba Cloud provides for you to access services.

Response parameters

Parameter Type Example Description
SecurityIpGroups

The whitelist groups of the instance.

└SecurityIpGroupAttribute String ""

The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.

└SecurityIpGroupName String default

The name of the whitelist group.

└SecurityIpList String 100.xxx.xxx.xxx/24,10.xxx.xxx.xxx

The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.

RequestId String EFC9161F-15E3-4A6E-8A99-C09916D1F464

The ID of the request.

Examples

Sample request


https://r-kvstore.aliyuncs.com/
? Action=DescribeSecurityIps
&InstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

Sample success response

XML format

<DescribeSecurityIpsResponse>
  <SecurityIpGroups>
    <SecurityIpGroup>
      <SecurityIpList>127.0.0.1</SecurityIpList>
      <SecurityIpGroupAttribute/>
      <SecurityIpGroupName>default</SecurityIpGroupName>
    </SecurityIpGroup>
    <SecurityIpGroup>
      <SecurityIpList>100.xxx.xxx.xxx/24,10.xxx.xxx.xxx</SecurityIpList>
      <SecurityIpGroupAttribute>hidden</SecurityIpGroupAttribute>
      <SecurityIpGroupName>rds_replica_group</SecurityIpGroupName>
    </SecurityIpGroup>
  </SecurityIpGroups>
  <RequestId>EFC9161F-15E3-4A6E-8A99-C09916D1F464</RequestId>
</DescribeSecurityIpsResponse>

JSON format

{
	"SecurityIpGroups":{
		"SecurityIpGroup":[
			{
				"SecurityIpList":"127.0.0.1",
				"SecurityIpGroupAttribute":"",
				"SecurityIpGroupName":"default"
			},
			{
				"SecurityIpList":"100.xxx.xxx.xxx/24,10.xxx.xxx.xxx",
				"SecurityIpGroupAttribute":"hidden",
				"SecurityIpGroupName":"rds_replica_group"
			}
		]
	},
	"RequestId":"EFC9161F-15E3-4A6E-8A99-C09916D1F464"
}

Error codes

View error codes.