LoadBalancerJoinSecurityGroup - Associate NLB instance with security group - Server Load Balancer

Operation description

You must create a security group before calling this operation. CreateSecurityGroup.
An NLB instance can be associated with up to four security groups.
To query security groups associated with an NLB instance, call GetLoadBalancerAttribute.
LoadBalancerJoinSecurityGroup is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. Call GetJobStatus to query the task status.
- If the task is in the Succeeded state, the security group is associated.
- If the task is in the Processing state, the security group is being associated. In this case, you can perform only query operations.

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

nlb:LoadBalancerJoinSecurityGroup

update

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
SecurityGroupIds	array	Yes	The IDs of security groups to associate with the NLB instance.
	string	No	A security group ID.	sg-bp1fg655nh68xyz9****
LoadBalancerId	string	Yes	The ID of the NLB instance to associate with a security group.	nlb-83ckzc8d4xlp8o****
DryRun	boolean	No	Specifies whether to perform a dry run without executing the operation. Valid values: true: validates the request without performing the operation. Checks required parameters, request syntax, and limits. If validation fails, an error is returned. If validation succeeds, the `DryRunOperation` error code is returned. false (default): validates and executes the request. If validation succeeds, a 2xx HTTP status code is returned.	true
ClientToken	string	No	The client token used to ensure idempotence of the request. You can use the client to generate the token. The token must be unique across requests and can contain only ASCII characters. Note If you do not specify this parameter, the system uses the request ID as the client token. The request ID is different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The region ID of the NLB instance. Call DescribeRegions to query available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SystemBusy	System is busy, please try again later.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	The quota is insufficient, currently used %s/%s. Please modify the quota size in the quota center.
400	Conflict.SecurityGroup	The SecurityGroup [%s] is conflict.	The specific resource is conflict.
400	Mismatch.%s	The %s is mismatched for %s and %s.
400	OperationDenied.%s	The operation is not allowed because of %s.
400	TagInvokeError	listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records.
400	Conflict.Lock	The Lock [%s] is conflict.	The specific resource is conflict.
400	Mismatch.vpc	The Vpc is mismatched for %s and %s.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	ResourceInCreating.loadbalancer	The specified resource of loadbalancer is creating, please try again later.	The specified resource of loadbalancer is creating, please try again later.
400	ResourceInConfiguring.loadbalancer	The specified resource of loadbalancer is being configured, please try again later.	The specified resource of loadbalancer is being configured, please try again later.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
403	Forbidden.SecurityGroup	Authentication is failed for SecurityGroup.	Authentication is failed for SecurityGroup.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer resource was not found. Please check the input parameters.
404	ResourceNotFound.SecurityGroup	The specified resource of SecurityGroup is not found.	The specified SecurityGroup resource was not found. Please check the input parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.