SetLoadBalancerSecurityGroups

Last updated: 2020-07-31 09:56:41

1. API Description

Domain name for API request: clb.tencentcloudapi.com.

This API (SetLoadBalancerSecurityGroups) is used to bind/unbind security groups for a public network CLB instance. You can use the DescribeLoadBalancers API to query the security groups bound to a CLB instance. This API uses set semantics.
During a binding operation, the input parameters need to be all security groups to be bound to the CLB instance (including those already bound ones and new ones).
During an unbinding operation, the input parameters need to be all the security groups still bound to the CLB instance after the unbinding operation. To unbind all security groups, you can leave this parameter empty or pass in an empty array. Note: Private network CLB do not support binding security groups.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: SetLoadBalancerSecurityGroups.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String CLB instance ID
SecurityGroups.N No Array of String Array of security group IDs. One CLB instance can be bound to up to 50 security groups. If you want to unbind all security groups, you do not need to pass in this parameter, or you can pass in an empty array.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Unbinding a security group from a CLB instance

A CLB instance was previously bound to two security groups: sg-0936o7sd and sg-12345678. This example shows you how to unbind the security group sg-12345678 from this instance.

Input Example

https://clb.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&SecurityGroups.0=sg-0936o7sd
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04644"
  }
}

Example2 Binding multiple security groups to a CLB instance

A CLB instance was not previously bound to any security group. This example shows you how to bind the security groups sg-0936o7sd and sg-12345678 to this instance.

Input Example

https://clb.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&SecurityGroups.0=sg-0936o7sd
&SecurityGroups.1=sg-12345678
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04633"
  }
}

Example3 Unbinding all security groups

A CLB instance was previously bound to several security groups. This example shows you how to unbind all security groups from this instance.

Input Example

https://clb.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04655"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameter.LBIdNotFound Wrong CLB instance ID.
InvalidParameterValue Wrong parameter value.
InvalidParameterValue.Length Wrong parameter length.
UnauthorizedOperation Unauthorized operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help