调用LoadBalancerJoinSecurityGroup接口为网络型负载均衡实例绑定已创建的安全组。

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 LoadBalancerJoinSecurityGroup

系统规定参数。取值：LoadBalancerJoinSecurityGroup。

SecurityGroupIds.N String 否 sg-bp1fg655nh68xyz9****

安全组ID。
LoadBalancerId String 是 nlb-83ckzc8d4xlp8o****

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

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

  • true：发送检查请求，不会为实例绑定安全组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

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

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

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String 否 cn-hangzhou

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

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。
JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

异步任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=LoadBalancerJoinSecurityGroup
&SecurityGroupIds=["sg-bp1fg655nh68xyz9****"]
&LoadBalancerId=nlb-83ckzc8d4xlp8o****
&DryRun=true
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<LoadBalancerJoinSecurityGroupResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</LoadBalancerJoinSecurityGroupResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId" : "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

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