All Products
Search
Document Center

ApsaraDB RDS:ModifySecurityGroupConfiguration

Last Updated:Dec 05, 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ModifySecurityGroupConfigurationupdate
*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 10 security groups. Separate multiple security groups with commas (,). To delete an ECS security group, 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
Itemsarray<object>

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

EcsSecurityGroupRelationobject
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.
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.

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