Domain name for API request: clb.intl.tencentcloudapi.com.
This API is used to bind or unbind security groups for a public network load balancing instance. To query currently bound security groups of a load balancing instance, use the DescribeLoadBalancers API (https://www.tencentcloud.comom/document/product/1108/48459?from_cn_redirect=1). This API follows set semantics.
This API is used to pass in all security groups that should be bound to the Cloud Load Balancer instance during the binding operation (bound + new binding).
For unbinding operations, the input parameters should specify all security groups bound to a CLB instance after unbinding. If you want to unbind all security groups, you can omit this parameter or input an empty array. Note: After a private network CLB is bound to an EIP, the security groups on the CLB do not take effect for the traffic from the EIP, but take effect for the traffic from the private network CLB.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: SetLoadBalancerSecurityGroups. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| LoadBalancerId | Yes | String | ID of the cloud load balancer instance. you can call the DescribeLoadBalancers API to query the ID. |
| SecurityGroups.N | No | Array of String | Specifies an array of security group ids. a load balancing instance supports a maximum binding of 50 security groups. to unbind all security groups, omit this parameter. Can be queried through the DescribeSecurityGroups api. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to unbind all security groups from a CLB instance which has been bound to multiple security groups.
https://clb.intl.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&<Common request parameters>{
"Response": {
"RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04644"
}
}
This example shows you how to unbind the security group sg-12345678 from a CLB instance which has been bound to two security groups sg-0936o7sd and sg-12345678.
https://clb.intl.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&SecurityGroups.0=sg-0936o7sd
&<Common request parameters>{
"Response": {
"RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04633"
}
}
This example shows you how to bind the security groups sg-0936o7sd and sg-12345678 to a CLB instance which has not been bound to any security groups.
https://clb.intl.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&SecurityGroups.0=sg-0936o7sd
&SecurityGroups.1=sg-12345678
&<Common request parameters>{
"Response": {
"RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04655"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.ResourceInOperating | The specified resource is currently being operated. Please try again later. |
| InternalError | Internal error. |
| InvalidParameter.FormatError | Wrong parameter format. |
| InvalidParameter.LBIdNotFound | Wrong CLB instance ID. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.Length | Wrong parameter length. |
| LimitExceeded | Quota exceeded. |
| UnauthorizedOperation | Unauthorized operation. |
Feedback