Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying Solution Template Settings
Updated on 2025-08-11 GMT+08:00
View PDF
Share

Querying Solution Template Settings

Function

This API is used to query the number of replicas, shards, and nodes corresponding to a specified instance or deployment mode. Before calling this API:

Constraints

The request parameters solution and instance_id cannot be both empty. If the parameters are both configured, the value of instance_id is used.

URI

GET /v3/{project_id}/deployment-form
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

No

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

solution

No

Definition

Solution template name.

Constraints

N/A

Range
  • triset: HA (1 primary + 2 standby)
  • hcs2: distributed combined deployment. Only DB instances of version V2.0-3.223 or later are supported.

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Parameter description

Name

Type

Description

initial_node_num

Integer

Definition

Number of initial nodes. If solution is set to triset, this parameter is returned. Otherwise, null is returned.

Range

N/A

solution

String

Definition

Solution template name.

Range
  • triset: HA (1 primary + 2 standby)
  • hcs2: distributed combined deployment. Only DB instances of version V2.0-3.223 or later are supported.

shard_num

Integer

Definition

Number of shards.

Range

N/A

replica_num

Integer

Definition

Number of replicas.

Range

N/A

Example Request

Querying solution template settings

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/fff3cb7f644d4fc9a3c58f2bfe239b9e/deployment-form?solution=triset

Example Response

Solution template settings queried.

{ 
  "initial_node_num" : 3, 
  "solution" : "triset", 
  "shard_num" : 1, 
  "replica_num" : 3 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Instance Management