Associates a security group with a Network Load Balancer (NLB) instance.
Operation description
-
Make sure that you have created a security group. For more information about how to create a security group, see CreateSecurityGroup .
-
An NLB instance can be associated with up to four security groups.
-
You can query the security groups that are associated with an NLB instance by calling the GetLoadBalancerAttribute operation.
-
LoadBalancerJoinSecurityGroup 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 GetJobStatus operation to query the status of a task.
- 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.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| nlb:LoadBalancerJoinSecurityGroup | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SecurityGroupIds | array | Yes | The security group ID of the instance. | |
| SecurityGroupId | string | Yes | The security group ID of the instance. | sg-bp1fg655nh68xyz9**** |
| LoadBalancerId | string | Yes | The ID of the NLB instance to be associated with the security group. | nlb-83ckzc8d4xlp8o**** |
| DryRun | boolean | No | Specifies whether to perform a dry run, without performing the actual request. Valid values:
| true |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client 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 |
| RegionId | string | No | The region ID of the NLB instance. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-10-30 | The Error code has changed | View Change Details |
| 2023-10-12 | The Error code has changed | View Change Details |
| 2023-09-12 | The Error code has changed | View Change Details |
| 2023-09-05 | The Error code has changed | View Change Details |
| 2023-08-22 | The Error code has changed | View Change Details |