Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Dedicated - Instance Management/ Adding Load Balancers in Batches
Updated on 2026-05-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding Load Balancers in Batches

Function

Add load balancers in batches. This operation is supported only for NLB gateways.

If there is an ELB listener whose listening port is 80, 443, or a custom port configured in APIG, force_overwrite_enabled must be set to true. Otherwise, the ELB cannot be added.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

elb_details

Yes

Array of ElbAddedInfo objects

ELB details.

Array Length: 1 - 10
Table 4 ElbAddedInfo

Parameter

Mandatory

Type

Description

id

Yes

String

ELB ID.

Minimum: 32

Maximum: 36

force_overwrite_enabled

No

Boolean

Whether to delete the listener whose listening port is 80, 443, or a custom port configured in APIG. If there is an ELB listener whose listening port is 80, 443, or a custom port configured in APIG, this parameter must be set to true. Otherwise, the ELB cannot be added.

Default: true

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

instance_id

String

Instance ID.

Minimum: 32

Maximum: 36

message

String

Job information.

Minimum: 0

Maximum: 200

job_id

String

Job ID.

Minimum: 36

Maximum: 36

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Add a load balancer.

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

Example Responses

Status code: 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"
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

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

Status code: 404

Not Found

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

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.