All Products
Search
Document Center

ApsaraDB RDS:ModifySecurityGroupConfiguration

Last Updated:Mar 13, 2024

Changes the ECS security groups to which an instance is added.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxx
SecurityGroupIdstringYes

The ID of the ECS security group. Each instance can be added to up to three security groups. Separate the security group IDs with commas (,). To delete an ECS security group for the instance, leave this parameter empty. You can call the DescribeSecurityGroups operation to query the ID of the ECS security group.

sg-xxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceNamestring

The instance ID.

rm-uf6wjk5xxxxxx
RequestIdstring

The request ID.

8585861B-8F0D-4D17-9460-C42255EB10C0
Itemsobject []

An array that consists of information about the ECS security group.

NetworkTypestring

The network type of the ECS security group. Valid values:

  • Classic
  • VPC
VPC
SecurityGroupIdstring

The ID of the ECS security group.

sg-xxxxxxx
RegionIdstring

The region ID.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "DBInstanceName": "rm-uf6wjk5xxxxxx",
  "RequestId": "8585861B-8F0D-4D17-9460-C42255EB10C0",
  "Items": {
    "EcsSecurityGroupRelation": [
      {
        "NetworkType": "VPC",
        "SecurityGroupId": "sg-xxxxxxx",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400AssociatedEcsSecurityGroupIdQuotaExceedSecurity groups quota exceededThe operation failed. The number of security groups that are configured for the RDS instance exceeds the quota.

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