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-18 GMT+08:00
View PDF

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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balance
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

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

Restrictions:

None

Value range:

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

Default value:

None

instance_id

Yes

DB instance ID.

Request Parameters

None

Response Parameters

Table 2 Parameter description

Name

Type

Description

balanced

Boolean

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

  • true: balanced.
  • false: unbalanced.

Example Request

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

GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/balance

Example Response

The host load is balanced.

{
	"balanced": true
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management