文档首页/ API网关 APIG/ API参考/ 专享版API(V2)/ 专享版-实例管理/ 批量添加负载均衡器 - BatchAddExtraElbs
更新时间:2026-04-29 GMT+08:00
分享

批量添加负载均衡器 - BatchAddExtraElbs

功能介绍

批量添加负载均衡器,仅当实例为NLB系列规格时支持。

当添加的弹性负载均衡器中已有监听端口为80、443或在APIG配置的自定义端口的监听器时,force_overwrite_enabled必须置为true,否则无法正常添加该ELB。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apig:instance:batchAddExtraElbs

    Write

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    • elb:loadbalancers:show
    • elb:loadbalancers:update
    • elb:listeners:list
    • elb:listeners:create
    • elb:listeners:delete
    • elb:pools:create
    • elb:members:create
    • elb:healthmonitors:create
    • elb:nativeLoadbalancerTags:create

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/extra-elbs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID,在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

elb_details

Array of ElbAddedInfo objects

弹性负载均衡具体信息。

数组长度:1 - 10

表4 ElbAddedInfo

参数

是否必选

参数类型

描述

id

String

弹性负载均衡ID。

最小长度:32

最大长度:36

force_overwrite_enabled

Boolean

删除监听端口为80、443或在APIG配置的自定义端口的监听器开关。当弹性负载均衡器中已有监听端口为80、443或在APIG已配置的自定义端口的监听器时,该参数必须置为true,否则无法添加该ELB。

缺省值:true

响应参数

状态码:202

表5 响应Body参数

参数

参数类型

描述

instance_id

String

实例ID。

最小长度:32

最大长度:36

message

String

任务信息。

最小长度:0

最大长度:200

job_id

String

任务编号。

最小长度:36

最大长度:36

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

添加负载均衡器。

{
  "elb_details" : [ {
    "id" : "85392b45-685c-4f77-b19a-14ad875b8190",
    "force_overwrite_enabled" : true
  }, {
    "id" : "11112b45-685c-4f77-b19a-14ad875b8190",
    "force_overwrite_enabled" : false
  } ]
}

响应示例

状态码:202

Accepted

{
  "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
  "message" : "JOB_ASSIGNED_FOR_UPDATE_0077I:The job JOB-a7c1241c33334490a3fdcd11102bcbda is assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running updating",
  "job_id" : "JOB-a7c1241c33334490a3fdcd11102bcbda"
}

状态码:400

Bad Request

{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[elb_id]"
}

状态码:401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码:403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码:404

Not Found

{
  "error_code" : "APIC.7302",
  "error_msg" : "Instance not found"
}

状态码:500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

状态码

状态码

描述

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档