文档中心>负载均衡>API 文档>其他相关接口>设置负载均衡实例的安全组

设置负载均衡实例的安全组

最近更新时间:2024-04-03 11:13:55

我的收藏

1. 接口描述

接口请求域名: clb.tencentcloudapi.com 。

SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置(绑定、解绑)安全组操作。查询一个负载均衡实例目前已绑定的安全组,可使用 DescribeLoadBalancers 接口。本接口是set语义,
绑定操作时,入参需要传入负载均衡实例要绑定的所有安全组(已绑定的+新增绑定的)。
解绑操作时,入参需要传入负载均衡实例执行解绑后所绑定的所有安全组;如果要解绑所有安全组,可不传此参数,或传入空数组。注意:内网 CLB 绑定 EIP 后,CLB 上的安全组对来自 EIP 的流量不生效,对来自内网 CLB 的流量生效。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SetLoadBalancerSecurityGroups。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID
示例值:lb-cuxw2r00
SecurityGroups.N Array of String 安全组ID构成的数组,一个负载均衡实例最多可绑定50个安全组,如果要解绑所有安全组,可不传此参数,或传入空数组。
示例值:["sg-0936o7sd\r\n","sg-12345678\r\n"]

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 解绑所有安全组

负载均衡实例原来已绑定若干个安全组,执行本操作后,所有安全组都将从此负载均衡实例解绑。

输入示例

https://clb.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&<公共请求参数>

输出示例

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

示例2 从负载均衡实例解绑一个安全组

负载均衡实例原来绑定了两个安全组: sg-0936o7sd、sg-12345678,执行本操作后,安全组 sg-12345678 将从此负载均衡实例解绑。

输入示例

https://clb.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&SecurityGroups.0=sg-0936o7sd
&<公共请求参数>

输出示例

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

示例3 绑定多个安全组至负载均衡实例

负载均衡实例原来未绑定任何安全组,执行本操作后,安全组 sg-0936o7sd、sg-12345678 将被绑定至此负载均衡实例。

输入示例

https://clb.tencentcloudapi.com/?Action=SetLoadBalancerSecurityGroups
&LoadBalancerId=lb-cuxw2r00
&SecurityGroups.0=sg-0936o7sd
&SecurityGroups.1=sg-12345678
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.ResourceInOperating 正在操作指定的资源,请稍后重试。
InternalError 内部错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制。
UnauthorizedOperation 未授权操作。