AI 助理
备案控制台
文档
产品文档
输入文档关键字查找
首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 实例 LoadBalancerJoinSecurityGroup - 负载均衡实例加入安全组

LoadBalancerJoinSecurityGroup - 负载均衡实例加入安全组

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

为应用型负载均衡实例绑定已创建的安全组。

接口说明

  • 安全组功能默认不开放，如需使用，请向商务经理申请。

  • 请确保您已创建安全组。创建安全组，请参见 CreateSecurityGroup 。

  • 一个应用型负载均衡实例最多支持加入 4 个安全组。

  • 您可以通过 GetLoadBalancerAttribute 接口查询实例绑定的安全组。

  • LoadBalancerJoinSecurityGroup 属于异步接口，即系统返回一个请求 ID，但该应用型负载均衡实例绑定安全组尚未成功，系统后台的绑定任务仍在进行。您可以调用 ListAsynJobs 查询安全组的绑定状态：

    • 当任务状态处于 Succeeded 时，表示安全组绑定成功。

    • 当任务状态处于 Processing 时，表示安全组正在绑定中，在该状态下，您只能执行查询操作，不能执行其他操作。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:LoadBalancerJoinSecurityGroupnone
  • LoadBalancer
    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
    无
无

请求参数

名称类型必填描述示例值
SecurityGroupIdsarray是

安全组 ID 集合。

string是

安全组 ID。

sg-m5e7xkprgt1pi1ik****
LoadBalancerIdstring是

应用型负载均衡实例 ID。

alb-h7kcw4g4nnvtqp****
DryRunboolean否

是否只预检此次请求，取值：

  • true：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring否

客户端 Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000

返回参数

名称类型描述示例值
object

创建结果

JobIdstring

异步任务 ID

8fe81f25-79a0-4fa0-9036-f2601fda****
RequestIdstring

请求 ID

D3B9AE45-F5DB-58E3-A4B5-EE58F1EC****

示例

正常返回示例

JSON格式

{
  "JobId": "8fe81f25-79a0-4fa0-9036-f2601fda****",
  "RequestId": "D3B9AE45-F5DB-58E3-A4B5-EE58F1EC****"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.LoadBalancerThe status of %s [%s] is incorrect.资源%s [%s]的状态无效。
400ResourceAlreadyAssociated.SecurityGroupThe specified resource of %s is already associated.安全组已经绑定了此负载均衡实例
400ResourceQuotaExceeded.SecurityGroupNumThe quota of %s is exceeded for resource %s, usage %s/%s.实例绑定的安全组数目超限
400OperationDenied.SecurityGroupNotSupportThe operation is not allowed because of %s.不支持绑定安全组
400OperationDenied.LbAssociatedAclCanNotJoinSecurityGroupThe operation is not allowed because of loadBalancer associated acl can not join security group.不允许该操作，原因是负载均衡实例下的监听已经绑定过访问控制策略，则不允许再加入安全组
404ResourceNotFound.LoadBalancerThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.SecurityGroupThe specified resource %s is not found.找不到安全组资源

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-18OpenAPI 错误码发生变更查看变更详情
上一篇：DisableLoadBalancerIpv6Internet - 关闭负载均衡IPv6公网下一篇：LoadBalancerLeaveSecurityGroup - 负载均衡实例移出安全组
文档推荐