更新时间:2025-07-29 GMT+08:00

修改参数

功能介绍

按节点类型修改节点参数。

URI

PUT /v3/{project_id}/instances/{instance_id}/starrocks/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

StarRocks实例ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表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参数

参数

是否必选

参数类型

描述

node_type

String

参数解释

节点类型。

约束限制

不涉及。

取值范围

  • be

  • fe

默认取值

不涉及。

parameter_values

Map<String,String>

参数解释

参数名和参数值映射关系。用户可以基于默认参数模板的参数,自定义的参数值。不传入该参数,则保持原参数信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

修改指定实例参数的任务ID。

取值范围

不涉及。

restart_required

Boolean

参数解释

是否需要重启。

取值范围

true:是。

false:否。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/3ef58db3986540d19f95151309368d34in17/starrocks/configurations

{
  "parameter_values" : {
    "sync_tablet_meta" : "true"
  },
  "node_type" : "be"
}

响应示例

状态码:200

参数修改返回。

{
  "job_id" : "aacd2f81-3fcb-427b-a52e-142639c6d1b9",
  "restart_required" : false
}

状态码

请参见状态码

错误码

请参见错误码