All Products
Search
Document Center

ApsaraDB for Redis:DescribeSecurityIps

Last Updated:Nov 03, 2023

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.

debugging

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:DescribeSecurityIpsREAD
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The IP addresses in the whitelist. A maximum of 1,000 IP addresses can be specified in a whitelist.

r-bp1zxszhcgatnx****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The name of the whitelist.

EFC9161F-15E3-4A6E-8A99-C09916D1****
SecurityIpGroupsobject []

The ID of the request.

SecurityIpGroupAttributestring

The operation that you want to perform. Set the value to DescribeSecurityIps.

hidden
SecurityIpListstring

The IP addresses in the whitelist.

100.100.202.***/24,10.10.10.***
SecurityIpGroupNamestring

The name of the security group.

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 codeError codeError messageDescription
404InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.The instance does not exist in the records. Call the DescribeInstances operation to query the instances that belong to the account.

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

Change history

Change timeSummary of changesOperation
2023-08-16The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Added Error Codes: 404