Changes the ECS security groups to which an ApsaraDB for RDS instance is added.
Operation Description
After an RDS instance is added to an ECS security group, all ECS instances in the security group can access the RDS instance. For more information, see Configure a whitelist for an RDS instance.
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:ModifySecurityGroupConfiguration | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The ID of the instance. | rm-uf6wjk5xxxxxx |
SecurityGroupId | string | Yes | The ID of the ECS security group. Each RDS 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 RDS instance, leave this parameter empty. You can call the DescribeSecurityGroups operation to query the ECS security group list. | sg-xxxxxxx |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBInstanceName": "rm-uf6wjk5xxxxxx",
"RequestId": "8585861B-8F0D-4D17-9460-C42255EB10C0",
"Items": {
"EcsSecurityGroupRelation": [
{
"NetworkType": "VPC",
"SecurityGroupId": "sg-xxxxxxx",
"RegionId": "cn-hangzhou"
}
]
}
}
JSON
format
{
"DBInstanceName": "rm-uf6wjk5xxxxxx",
"RequestId": "8585861B-8F0D-4D17-9460-C42255EB10C0",
"Items": {
"EcsSecurityGroupRelation": [
{
"NetworkType": "VPC",
"SecurityGroupId": "sg-xxxxxxx",
"RegionId": "cn-hangzhou"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | AssociatedEcsSecurityGroupIdQuotaExceed | Security groups quota exceeded | The 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.