Help Center/ GeminiDB/ API Reference/ API v3/ Instances/ Querying an Automatic Scale-out Policy
Updated on 2026-09-22 GMT+08:00

Querying an Automatic Scale-out Policy

Function

This API is used to query an automatic scale-out policy.

Constraints

This API supports the following instance:

  • GeminiDB Cassandra

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:getAutoNodeExpansionPolicy

    Read

    instance *

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

    nosql:instance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/node-auto-expansion-policy

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

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

switch_option

Boolean

Definition

Whether the switch for automatically adding nodes is enabled

Range

  • true: enabled
  • false: disabled

overload_node_threshold

Integer

Definition

Percentage of overloaded nodes. When the memory or CPU usage of a node is greater than or equal to the value (in percentage) of this parameter, automatic scale-out is triggered.

Range

An integer ranging from 1 to 100

cpu_threshold

Integer

Definition

CPU usage of nodes for which autoscaling is triggered, in percentage (%).

Range

An integer ranging from 1 to 100

mem_threshold

Integer

Definition

Memory usage of nodes for which autoscaling is triggered, in percentage (%).

Range

An integer ranging from 1 to 100

step

Integer

Definition

Number of nodes to be added each time

Range

The value is a positive integer greater than or equal to 1. The maximum value cannot exceed the upper limit of nodes that can be added.

node_limit

Integer

Definition

Maximum number of nodes that can be automatically added

Range

The value is a positive integer greater than or equal to 1. The maximum value cannot exceed the upper limit of nodes that can be added to the current instance.

Example Requests

Querying an automatic scale-out policy

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/node-auto-expansion-policy

Example Responses

Status code: 200

Success

{    
  "switch_option" : true,
  "overload_node_threshold" : 33,
  "cpu_threshold" : 80, 
  "mem_threshold" : 80,   
  "step" : 3,   
  "node_limit" : 10
 }

Status Codes

See Status Codes.

Error Codes

See Error Codes.