Use ModifySecurityIps API to configure IP whitelist - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can also modify whitelists in the Tair (Redis OSS-compatible) console. For more information, see Configure a whitelist for an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:ModifySecurityIps

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
SecurityIps	string	Yes	The IP addresses to add to the whitelist. You can specify up to 1,000 IP addresses, separated by commas (,). Supported formats: 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24. In CIDR notation, /24 indicates the prefix length, which ranges from 1 to 32.	100.64.*.0/24,10.101.11.*
SecurityIpGroupName	string	No	The name of the IP address whitelist. Warning The system-generated whitelist cannot be modified. If you do not specify this parameter, the default whitelist is modified.	default
SecurityIpGroupAttribute	string	No	The attribute of the whitelist. Default value: empty. Whitelists with this parameter set to hidden are not displayed in the console.	hidden
ModifyMode	string	No	The modification method for the whitelist. Valid values: Cover (default): overwrites the original whitelist. Append: appends data to the whitelist. Delete: deletes the whitelist.	Append

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	AAAF99B1-69ED-4E80-8CD5-272C09E4****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Forbbiden.MinorVersion	The operation is not permitted for current minor version.
400	InvalidGroupName.Format	Sepecified group name is not valid.
400	LockTimeout	The request processing has failed due to lock timeout.	The current request conflicts with another request, please try again later.
404	InvalidSecurityIPList.NotFound	Specified same security IP does not exist or at least one security IP need.	The same IP as the specified IP was not found in the whitelist group, or no IP was passed in.
409	SecurityIPList.Duplicate	Specified same security IP already exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.