Use ModifySecurityGroupConfiguration to reset security group configuration - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Note

This operation removes all existing security groups from the instance whitelist and adds only the security groups specified by the SecurityGroupId parameter. For more information about how to reset security groups in the Tair console, see Add security groups.

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:ModifySecurityGroupConfiguration

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	r-bp1zxszhcgatnx****
SecurityGroupId	string	Yes	The security group ID. You can specify up to 10 security groups. Separate multiple IDs with commas (,).	sg-bpcfmyiu4ekp****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	147CAC09-E8C6-43F8-9599-982A43D6****

Examples

Success response

JSON format

{
  "RequestId": "147CAC09-E8C6-43F8-9599-982A43D6****"
}

Error codes

HTTP status code	Error code	Error message
400	EngineNotSupported	Engine specified cannot be supported the operation.
400	AssociatedEcsSecurityGroupIdQuotaExceed	SecurityGroupId参数超过能使用的最大数量.
400	MissingInstanceId	InstanceId is mandatory for this action.
400	InvalidParam	Specified ecs security group id is not valid.
400	InvalidIzNo.NotSupported	the Specified Zone not supported.
403	AssociatedEcsSecurityGroupId.QuotaExceed	SecurityGroupIdQuotaExceeded exceeding the allowed amount of SecurityGroupId.
404	MissingParameter	The input parameter “DBInstanceId” that is mandatory for processing this request is not supplied.
404	InvalidInstanceId.NotFound	Specified instance does not exist.
404	InvalidRegionZoneNotFound	Specified Region does not exist in RDS.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.