Add an ENS instance to a security group using JoinSecurityGroup - ENS

Operation description

Before you To add an instance to a security group, make sure that the instance is in the Stopped or Running state.

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

ens:JoinSecurityGroup

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SecurityGroupId	string	Yes	The ID of the security group.	sg-bp67acfmxazb4ph***
InstanceId	string	No	The ID of the instance.	i-bp67acfmxazb4ph***
NetworkInterfaceId	string	No	The ID of the ENI.	eni-58z57orgmt6d1****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	The specified security group ID does not exist.
400	SecurityGroupRuleConflict.Duplicated	The SecurityGroup rule already exists.	duplicate security group rules.
400	AuthorizationLimitExceed	The limit of authorization records in the security group reaches.	The number of security group rules exceeds the limit.
400	SecurityGroupRule.NotFound	The input security group rule does not exist.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	The current operation is not supported. The disk is being reset.
400	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instance does not exist.
400	ens.interface.error	An error occurred while calling the API.
400	RegionNotSupport	The specified InstanceId of regionId does not support SecurityGroup
400	InstanceAlreadyBound	The instance is already bound to a SecurityGroup.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.