Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying an Automatic Scale-out Policy

Updated on 2025-11-17 GMT+08:00

View PDF

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

GeminiDB Cassandra

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

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

**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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
switch_option	Boolean	Explanation: Whether the switch for automatically adding nodes is enabled Constraints: N/A Values: true: enabled false: disabled Default value: N/A
overload_node_threshold	Integer	Explanation: Percentage of overloaded nodes. When the memory or CPU usage of a node is greater than or equal to overload_node_threshold%, automatic scale-out is triggered. Constraints: N/A Values: An integer ranging from 1 to 100 Default value: N/A
cpu_threshold	Integer	Explanation: CPU usage of nodes for which autoscaling is triggered Constraints: N/A Values: An integer ranging from 1 to 100 Default value: N/A
mem_threshold	Integer	Explanation: Memory usage of nodes for which autoscaling is triggered Constraints: N/A Values: An integer ranging from 1 to 100 Default value: N/A
step	Integer	Explanation: Number of nodes to be added each time Constraints: N/A Values: 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. Default value: N/A
node_limit	Integer	Explanation: Maximum number of nodes that can be automatically added Constraints: N/A Values: 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. Default value: N/A

Example Request

Querying an automatic scale-out policy

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

Example Response

Status code: 200

Successful request

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