ModifySecurityGroupConfiguration - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Note

For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.

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 support 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

dds:ModifySecurityGroupConfiguration

update

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	dds-bpxxxxxxxx
SecurityGroupId	string	Yes	The ID of the ECS security group. Note You can bind up to 10 ECS security groups to an ApsaraDB for MongoDB instance. You can call the DescribeSecurityGroup operation of ECS to query the security groups in the specified region.	sg-bpxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	E062C482-1A4B-469E-938C-96D28CFAE42E

Examples

Success response

JSON format

{
  "RequestId": "E062C482-1A4B-469E-938C-96D28CFAE42E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingInstanceId	InstanceId is mandatory for this action.
400	InstanceStatusInvalid	Instance status is not valid.
400	InvalidParam	Specified ecs security group id is not valid.
400	InvalidIzNo.NotSupported	the Specified Zone not supported.
400	InvalidRegion_Zone_NotFound	Specified Region does not exist in RDS.
400	InvalidVpc.NotSupported	the Different vpc not supported.	Different VPCs are not supported.
403	AssociatedEcsSecurityGroupId.QuotaExceed	SecurityGroupIdQuotaExceeded exceeding the allowed amount of SecurityGroupId.
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.