SetSecurityGroupForLoadbalancers

Last updated: 2023-10-24 11:16:03

1. API Description

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

This API is used to bind or unbind a security group for multiple public network CLB instances. Note: Private network CLB do not support binding security groups.

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

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 Params. The value used for this API: SetSecurityGroupForLoadbalancers.
Version	Yes	String	Common Params. The value used for this API: 2018-03-17.
Region	No	String	Common Params. This parameter is not required for this API.
SecurityGroup	Yes	String	Security group ID, such as sg-12345678
OperationType	Yes	String	ADD: bind a security group; DEL: unbind a security group
LoadBalancerIds.N	Yes	Array of String	Array of CLB instance IDs

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 Binding a security group to multiple CLB instances

Input Example

https://clb.tencentcloudapi.com/?Action=SetSecurityGroupForLoadbalancers
&SecurityGroup=sg-12345678
&OperationType=ADD
&LoadBalancerIds.0=lb-0936o712
&LoadBalancerIds.1=lb-tttt5555
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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	Parameter error.
InvalidParameter.FormatError	Wrong parameter format.
InvalidParameter.LBIdNotFound	Wrong CLB instance ID.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.Length	Wrong parameter length.
UnauthorizedOperation	Unauthorized operation.

tencent cloud

Recent Pages