文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ HTAP参数对比 - CheckStarrocksParams
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

HTAP参数对比 - CheckStarrocksParams

功能介绍

对比实例参数和默认模板的差异。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:get

    Read

    -

    -

    gaussdb:param:list

    -

URI

POST /v3/{project_id}/configurations/starrocks/comparison

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us
  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

source_configuration_id

是

String

参数解释：

需要进行比较的源参数模板ID。通过查询StarRocks实例 - ListStarrocksInstanceInfo接口获得。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：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" : "a2069d40256f40078c52d90d6a91ee63pr17",
}

响应示例

状态码：200

参数之间区别的集合。

{
  "differences" : [ {
    "parameter_name" : "alter_tablet_worker_count",
    "source_value" : "4",
    "target_value" : "3"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版