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

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

最近更新时间:2019-05-14 17:03:34

1. 接口描述

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

SetLoadBalancerSecurityGroups 接口支持对一个负载均衡实例执行设置(绑定、解绑)安全组操作,查询一个负载均衡实例目前已绑定的安全组,可使用 DescribeLoadBalancers 接口。 绑定操作时,入参需要传入负载均衡实例要绑定的所有安全组(已绑定的+新增绑定的)。 解绑操作时,入参需要传入负载均衡实例执行解绑后所绑定的所有安全组;如果要解绑所有安全组,可传入空数组。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SetLoadBalancerSecurityGroups
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID
SecurityGroups.N Array of String 安全组ID构成的数组,一个负载均衡实例最多关联50个安全组,如果要解绑所有安全组,可不传此参数。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameterValue 参数取值错误
InvalidParameterValue.Length 参数长度错误。
UnauthorizedOperation 未授权操作