Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Changing a Load Balancing Address
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Changing a Load Balancing Address

Function

This API is used to change a load balancing address.

Constraints

This API supports the following instances:

  • GeminiDB Cassandra
  • GeminiDB Influx
  • GeminiDB Redis

Instances across subnets are not supported.

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • 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

    gaussdbfornosql:instance:updateLoadBalance

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:modifyInstanceLb

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/lb

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ip

Yes

String

Definition

New IP address of a load balancer

Constraints

N/A

Range

N/A

Default Value

N/A

lb_id

No

String

Definition

Load balancer ID. If an instance has multiple load balancer addresses, you can change the IP address of a specified load balancer. For details about how to obtain the value, see the load balancer information in Querying Instances and Details.

Constraints

If an instance has multiple load balancers, the IP address is mandatory.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Task ID

Range

N/A

Example Requests

Changing a load balancing address

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/e73893ef73754465a8bd2e0857bbf13ein12/lb
{
    "ip" : "192.168.10.1"
}

Example Responses

Status code: 202

Accept.

{    
    "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Instances