文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ 参数模板管理/ 对比参数模板- ListConfigurationsDifferences
更新时间:2025-10-21 GMT+08:00

对比参数模板 - ListConfigurationsDifferences

功能介绍

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:get

    Read

    -

    -

    gaussdb:param:list

    -

URI

POST /v3/{project_id}/configurations/comparison

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

source_configuration_id

String

参数解释

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

约束限制

不涉及。

取值范围

通过调用查询参数模板 - ListGaussMySqlConfigurations接口获取。

请求响应成功后在响应消息体中包含的“id”的值即为source_configuration_id值。

默认取值

不涉及。

target_configuration_id

String

参数解释

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

约束限制

不涉及。

取值范围

通过调用查询参数模板 - ListGaussMySqlConfigurations接口获取。

请求响应成功后在响应消息体中包含的“id”的值即为target_configuration_id值。

默认取值

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

differences

Array of ParamGroupParameterDifferences objects

参数解释

参数之间的区别集合。

表5 ParamGroupParameterDifferences

参数

参数类型

描述

parameter_name

String

参数解释

参数名称。

取值范围

不涉及。

source_value

String

参数解释

源参数模板中的参数值。

取值范围

不涉及。

target_value

String

参数解释

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

取值范围

不涉及。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

对比参数组。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/comparison
{
  "source_configuration_id" : "a2069d40256f40078c52d90d6a91ee63pr07",
  "target_configuration_id" : "0cd8ef851dc4422f98e7717205ed13e6pr07"
}

响应示例

状态码: 200

Success.

{
  "differences" : [ {
    "parameter_name" : "innodb_purge_threads",
    "source_value" : 1,
    "target_value" : 4
  }, {
    "parameter_name" : "connect_timeout",
    "source_value" : 10,
    "target_value" : 20
  } ]
}

状态码

请参见状态码

错误码

请参见错误码