文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 参数配置/ 参数模板比较 - ComparingParameterTemplates
更新时间：2025-11-27 GMT+08:00
查看PDF
分享

参数模板比较 - ComparingParameterTemplates

功能介绍

比较两个参数模板之间的差异。

接口约束

该接口支持如下数据库实例。

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx经典部署模式实例
  • GeminiDB Redis经典部署模式实例

只能比较相同节点类型、数据库版本、部署模式的参数模板，以了解该参数模板当前的配置情况。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:configuration:compare

    Read

    -

    -

    nosql:param:list

    -

URI

POST /v3/{project_id}/configurations/comparison

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

source_configuration_id

是

String

参数解释：

需要进行比较的源参数模板ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

target_configuration_id

是

String

参数解释：

需要进行比较的目标参数模板ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

differences

Array of 表5 objects

参数解释：

参数之间的区别集合。

取值范围：

不涉及。
表5 DiffDetails

参数

参数类型

描述

parameter_name

String

参数解释：

参数名称。

取值范围：

不涉及。

source_value

String

参数解释：

源参数模板中的参数值。

取值范围：

不涉及。

target_value

String

参数解释：

目标参数模板中的参数值。

取值范围：

不涉及。

请求示例

  • URI样例 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/comparison
  • 比较源参数模板和目标参数模板 
    { 
  "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr06", 
  "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr06" 
}

响应示例

状态码： 202

Accepted

{ 
  "differences" : [ { 
    "parameter_name" : "batch_size_fail_threshold_in_kb", 
    "source_value" : "1000", 
    "target_value" : "5000" 
  } ] 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数配置