Queries IP address whitelists of an ApsaraDB for Redis instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeSecurityIps |
The operation that you want to perform. Set the value to DescribeSecurityIps. |
InstanceId | String | Yes | r-bp1zxszhcgatnx**** |
The ID of the instance. |
RegionId | String | No | cn-hangzhou |
The ID of the region where the instance is deployed. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
SecurityIpGroups | Array of SecurityIpGroup |
The information about the IP address whitelist groups of the instance. |
|
SecurityIpGroup | |||
SecurityIpGroupAttribute | String | hidden |
The attribute of the IP address whitelist group. Default value: null. Note If the returned value of this parameter is hidden, the whitelist group is not displayed in the ApsaraDB for Redis console.
|
SecurityIpGroupName | String | default |
The name of the IP address whitelist group. |
SecurityIpList | String | 100.100.202.***/24,10.10.10. *** |
The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1,000. |
RequestId | String | EFC9161F-15E3-4A6E-8A99-C09916D1**** |
The ID of the request. |
Examples
Sample requests
https://r-kvstore.aliyuncs.com/?Action=DescribeSecurityIps
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>
Sample success responses
XML
format
<DescribeSecurityIpsResponse>
<SecurityIpGroups>
<SecurityIpGroup>
<SecurityIpList>127.0.0.1</SecurityIpList>
<SecurityIpGroupAttribute></SecurityIpGroupAttribute>
<SecurityIpGroupName>default</SecurityIpGroupName>
</SecurityIpGroup>
<SecurityIpGroup>
<SecurityIpList>100.100.202. ***/24,10.10.10. ***</SecurityIpList>
<SecurityIpGroupAttribute>hidden</SecurityIpGroupAttribute>
<SecurityIpGroupName>rds_replica_group</SecurityIpGroupName>
</SecurityIpGroup>
</SecurityIpGroups>
<RequestId>EFC9161F-15E3-4A6E-8A99-C09916D1****</RequestId>
</DescribeSecurityIpsResponse>
JSON
format
{
"SecurityIpGroups": {
"SecurityIpGroup": [
{
"SecurityIpList": "127.0.0.1",
"SecurityIpGroupAttribute": "",
"SecurityIpGroupName": "default"
},
{
"SecurityIpList": "100.100.202. ***/24,10.10.10. ***",
"SecurityIpGroupAttribute": "hidden",
"SecurityIpGroupName": "rds_replica_group"
}
]
},
"RequestId": "EFC9161F-15E3-4A6E-8A99-C09916D1****"
}
Error codes
For a list of error codes, visit the API Error Center.