All Products
Search
Document Center

Tair:ModifySecurityGroupConfiguration

Last Updated:Feb 20, 2024

Resets the security groups that are added to the whitelists of an ApsaraDB for Redis instance.

Operation description

Note After you call this operation, the security groups that are added to the whitelists of the ApsaraDB for Redis instance are deleted, and the security group specified by the SecurityGroupId parameter is added to the whitelists. For more information about how to reset security groups in the ApsaraDB for Redis console, see Add security groups.

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:ModifySecurityGroupConfigurationWRITE
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
SecurityGroupIdstringYes

The ID of the security group that you want to manage. You can specify up to 10 security groups. Separate multiple security group IDs with commas (,).

sg-bpcfmyiu4ekp****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

147CAC09-E8C6-43F8-9599-982A43D6****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400EngineNotSupportedEngine specified cannot be supported the operation.
400AssociatedEcsSecurityGroupIdQuotaExceed
400MissingInstanceIdInstanceId is mandatory for this action.
400InvalidParamSpecified ecs security group id is not valid.
400InvalidIzNo.NotSupportedthe Specified Zone not supported.
403AssociatedEcsSecurityGroupId.QuotaExceedSecurityGroupIdQuotaExceeded exceeding the allowed amount of SecurityGroupId.
404MissingParameterThe input parameter “DBInstanceId” that is mandatory for processing this request is not supplied.
404MissingParameterThe input parameter “SecurityGroupId” that is mandatory for processing this request is not supplied.
404InvalidInstanceId.NotFoundSpecified instance does not exist.
404InvalidRegionZoneNotFoundSpecified Region does not exist in RDS.

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