文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 实例管理/ 查询解决方案模板配置 - QueryingSolutionTemplateSettings
更新时间:2026-07-07 GMT+08:00
分享

查询解决方案模板配置 - QueryingSolutionTemplateSettings

功能介绍

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

接口约束

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

调试

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

URI

GET /v3/{project_id}/deployment-form

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例ID。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

solution

String

参数解释:

解决方案模板名称。

约束限制:

不涉及。

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文
  • en-us:英文

默认取值

en-us

响应参数

表3 参数说明

名称

参数类型

说明

initial_node_num

Integer

参数解释

初始节点数,单位:个。当solution为triset时,返回此参数,其余结果为null。

取值范围

不涉及。

solution

String

参数解释

解决方案模板名称。

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

shard_num

Integer

参数解释

分片数。单位:个。

取值范围

不涉及。

replica_num

Integer

参数解释

副本数。单位:个。

取值范围

不涉及。

each_expand_nodes

integer

参数解释

每次扩容的最小节点数。单位:个。

取值范围

不涉及。

max_shard_count

integer

参数解释

最大分片数。单位:个。

取值范围

不涉及。

each_shard_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,
  "each_expand_nodes": 1,
  "max_shard_count": 3,
  "each_shard_num": 3
}

状态码

错误码

请参见错误码

相关文档