All Products
Search
Document Center

ApsaraDB for Redis:ModifySecurityIps

Last Updated:May 28, 2024

Modifies the IP address whitelists of an ApsaraDB for Redis instance.

Operation description

You can also modify the whitelists of an instance in the ApsaraDB for Redis console. For more information, see Configure a whitelist for an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
SecurityIpsstringYes

The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.

100.64.***.0/24,10.101.11.***
SecurityIpGroupNamestringNo

The name of the IP address whitelist.

Warning You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.

default
SecurityIpGroupAttributestringNo

By default, this parameter is left empty. The attribute of the whitelist. The console does not display the whitelist whose value of this parameter is hidden.

hidden
ModifyModestringNo

The method that is used to modify the whitelist. Valid values:

  • Cover: overwrites the original whitelist.
  • Append: appends data to the whitelist.
  • Delete: deletes the whitelist.
Append

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

AAAF99B1-69ED-4E80-8CD5-272C09E4****

Examples

Sample success responses

JSONformat

{
  "RequestId": "AAAF99B1-69ED-4E80-8CD5-272C09E4****"
}

Error codes

HTTP status codeError codeError messageDescription
400Forbbiden.MinorVersionThe operation is not permitted for current minor version. The operation is not supported by this instance version.
400InvalidGroupName.FormatSepecified group name is not valid.-
400LockTimeoutThe request processing has failed due to lock timeout.The current request conflicts with another request. Try again later.
404InvalidSecurityIPList.NotFoundSpecified same security IP does not exist or at least one security IP need.-
409SecurityIPList.DuplicateSpecified same security IP already exists.-

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