LoadBalancerJoinSecurityGroup_网络型负载均衡_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 请确保您已创建安全组。创建安全组,请参见 CreateSecurityGroup
  • 一个网络型负载均衡实例最多支持加入 4 个安全组。
  • 您可以通过 GetLoadBalancerAttribute 接口查询实例绑定的安全组。
  • LoadBalancerJoinSecurityGroup 属于异步接口,即系统返回一个请求 ID,但该网络型负载均衡实例绑定安全组尚未成功,系统后台的绑定任务仍在进行。您可以调用 GetJobStatus 查询安全组的绑定状态:
    • 当任务状态处于 Succeeded 时,表示安全组绑定成功。
    • 当任务状态处于 Processing 时,表示安全组正在绑定中,在该状态下,您只能执行查询操作,不能执行其他操作。

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
nlb:LoadBalancerJoinSecurityGroup
Update
LoadBalancer
acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
SecurityGroup
acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

请求参数

字段名称字段详情
SecurityGroupIdsarray<string>

安全组 ID。

子级条数 <= 10
LoadBalancerIdstring

待绑定安全组的网络型负载均衡实例 ID。

示例值:nlb-83ckzc8d4xlp8o****参考取值来源:
    ListLoadBalancers
DryRunboolean

是否只预检此次请求。取值:展开详情

示例值:true
ClientTokenstring

客户端 Token,用于保证请求的幂等性。展开详情

示例值:123e4567-e89b-12d3-a456-426655440000
RegionIdstring

网络型负载均衡实例所在的地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
    SetHdMonitorRegionConfig

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:CEF72CEB-54B6-4AE8-B225-F876FF7BA984
JobIdstring

异步任务 ID。

示例值:72dcd26b-f12d-4c27-b3af-18f6aed5****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
SystemBusy
System is busy, please try again later.诊断
400
QuotaExceeded.QuotaInsufficient
The quota of %s is exceeded, usage %s/%s.诊断
400
Conflict.SecurityGroup
The SecurityGroup [%s] is conflict.诊断
400
Mismatch.%s
The %s is mismatched for %s and %s.诊断
400
OperationDenied.%s
The operation is not allowed because of %s.诊断
400
TagInvokeError
listTagsByResourceIds: InvalidResourceId.NotFound : The specified ResourceIds are not found in our records.诊断
400
Conflict.Lock
The Lock [%s] is conflict.诊断
400
Mismatch.vpc
The Vpc is mismatched for %s and %s.诊断
400
DryRunOperation
Request validation has been passed with DryRun flag set.诊断
400
ResourceInCreating.loadbalancer
The specified resource of loadbalancer is creating, please try again later.诊断
400
ResourceInConfiguring.loadbalancer
The specified resource of loadbalancer is being configured, please try again later.诊断
403
Forbidden.NoPermission
Authentication is failed for NoPermission.诊断
403
Forbidden.SecurityGroup
Authentication is failed for SecurityGroup.诊断
404
ResourceNotFound.loadBalancer
The specified resource of loadbalancer is not found.诊断
404
ResourceNotFound.SecurityGroup
The specified resource of SecurityGroup is not found.诊断

变更历史

变更时间变更内容概要操作
2023-10-30
变更错误码400
2023-10-12
变更错误码400
2023-09-12
变更错误码400
2023-09-05
变更错误码400
变更错误码403
变更错误码404
2023-08-22
新增错误码400
新增错误码403
新增错误码404
  • 1
  • 2
  • 10 条/页

相关示例