Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Checking Whether Host Load Is Unbalanced Due to a Primary/Standby Switchover
Updated on 2025-08-11 GMT+08:00

Checking Whether Host Load Is Unbalanced Due to a Primary/Standby Switchover

Function

This API is used to check whether the host load is unbalanced due to a primary/standby switchover. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/balance
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Parameter description

Name

Type

Description

balanced

Boolean

Definition

Whether the host load is unbalanced due to a primary/standby switchover.

Range

  • true: balanced.
  • false: unbalanced.

Example Request

Checking whether host load is unbalanced due to a primary/standby switchover

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instance/dsfae23fsfdsae3435in14/balance

Example Response

The host load is balanced.

{
	"balanced": true
}

Status Codes

Error Codes

For details, see Error Codes.