文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 查询解决方案模板配置
更新时间：2025-09-11 GMT+08:00
查看PDF
分享

查询解决方案模板配置

功能介绍

查询指定实例或者部署形态对应的副本数、分片数、节点数。

接口约束

请求参数solution和instance_id不能都为空。都传时以instance_id为准。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/deployment-form

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

否

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

solution

否

参数解释：

解决方案模板名称。

约束限制：

不涉及。

取值范围
  • triset：高可用（1主2备）。
  • hcs2：分布式版混合部署，只支持V2.0-3.223及以上版本。

默认取值：

不涉及。

请求参数

无。

响应参数

表2 参数说明

名称

参数类型

说明

initial_node_num

Integer

参数解释：

初始节点数。当solution为triset时，返回此参数，其余结果为null。

取值范围：

不涉及。

solution

String

参数解释：

解决方案模板名称。

取值范围
  • triset：高可用（1主2备）。
  • hcs2：分布式版混合部署，只支持V2.0-3.223及以上版本。

shard_num

Integer

参数解释：

分片数。

取值范围：

不涉及。

replica_num

Integer

参数解释：

副本数。

取值范围：

不涉及。

请求示例

查询解决方案模板配置。

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

响应示例

查询解决方案模板配置。

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

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档