tencent cloud

当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。
关闭

文档反馈

文档负载均衡API 文档Other APIsSetLoadBalancerSecurityGroups
文档负载均衡API 文档Other APIsSetLoadBalancerSecurityGroups

SetLoadBalancerSecurityGroups

最后更新时间:2024-09-05 19:28:17

1. API Description

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

This API is used to configure (bind and unbind) security groups for a public network CLB instance. You can use the DescribeLoadBalancers API to query the security groups currently bound to a CLB instance. This API follows the set semantics.For binding operations, the input parameters should specify all security groups that should be bound (have been bound and will be bound) to the CLB instance.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.

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: SetLoadBalancerSecurityGroups.
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.
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, 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.

4. Example

Example1 Unbinding All Security Groups

This example shows you how to unbind all security groups from a CLB instance which has been bound to multiple security groups.

Input Example

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

Output Example

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

Example2 Unbinding a Security Group from a CLB Instance

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.

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-5d7e96d04633"
    }
}

Example3 Binding Multiple Security Groups to a CLB Instance

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.

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-5d7e96d04655"
    }
}

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

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.
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.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持