Secure ALB Traffic by Adding to a Security Group via API - Server Load Balancer - Alibaba Cloud - Server Load Balancer: Central de Documentação do Alibaba Cloud

Operation description

By default, security groups are unavailable. To use security groups, contact your account manager.
Make sure that you have created a security group. For more information, see CreateSecurityGroup.
Each ALB instance can be added to at most four security groups.
To query the security groups of an ALB instance, call the GetLoadBalancerAttribute operation.
GetLoadBalancerAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListAsynJobs operation to query the status of the task.
- If the task is in the Succeeded state, the ALB instance is added to the security group.
- If the task is in the Processing state, the ALB instance is being added to the security group. In this case, you can query the task but cannot perform other 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

alb:LoadBalancerJoinSecurityGroup

none

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
SecurityGroupIds	array	Yes	The security group IDs.
	string	No	The security group ID.	sg-m5e7xkprgt1pi1ik****
LoadBalancerId	string	Yes	The ALB instance ID.	alb-h7kcw4g4nnvtqp****
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can use the client to generate the token, but you must ensure that the token is unique across requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The task result.
JobId	string	The ID of the asynchronous task.	8fe81f25-79a0-4fa0-9036-f2601fda****
RequestId	string	The request ID.	D3B9AE45-F5DB-58E3-A4B5-EE58F1EC****

Examples

Success response

JSON format

{
  "JobId": "8fe81f25-79a0-4fa0-9036-f2601fda****",
  "RequestId": "D3B9AE45-F5DB-58E3-A4B5-EE58F1EC****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	ResourceAlreadyAssociated.SecurityGroup	The specified resource of %s is already associated.
400	ResourceQuotaExceeded.SecurityGroupNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.SecurityGroupNotSupport	The operation is not allowed because of %s.
400	OperationDenied.LbAssociatedAclCanNotJoinSecurityGroup	The operation is not allowed because of loadBalancer associated acl can not join security group.	This operation is not allowed because a listener of the ALB instance is associated with an access control policy. The ALB instance cannot join a security group.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.SecurityGroup	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.