Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Changing a Load Balancing Address
Updated on 2025-11-17 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 instance types:

  • GeminiDB Cassandra
  • GeminiDB Influx
  • GeminiDB Redis

Instances across subnets are not supported.

Authorization

Each account is authorized to call all APIs, but its IAM users must be granted necessary permissions. For details, see Permission Policies and Supported Actions.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

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

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ip

Yes

String

Explanation:

New IP address of a load balancer

Constraints:

N/A

Values:

N/A

Default value:

N/A

lb_id

No

String

Explanation:

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.

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 202

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Explanation:

Task ID

Values:

N/A

Example Request

Changing a load balancing address

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

Example Response

Status code: 202

Accept.

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Instances