UpdateConfig - 更新集群配置

更新集群配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:UpdateConfigupdate
*全部资源
*

请求参数

名称类型必填描述示例值
RequestParsstring

扩展请求参数,JSON 格式。

{}
ClusterIdstring

集群 ID。

mse-09k1q11****
ConfigTypestring

配置格式,包括 TEXT、JSON、XML、HTML 等。

TEXT
TickTimestring

zookeeper 配置,时间单元,默认为 2000 毫秒。

2000
InitLimitstring

zookeeper 配置,实例最长连接时间,单位:秒。

100
SyncLimitstring

zookeeper 配置,实例连接超时时间,单位:秒。

10
MaxClientCnxnsstring

zookeeper 配置,单个客户端与单台服务器之间的连接数。
如果设置为 0,表示不作任何限制。

0
OpenSuperAclstring

zookeeper 配置,超级权限开关,取值如下:

  • true:打开
  • false:关闭
true
UserNamestring

用户名称。

说明 当 OpenSuperAcl 为 true 时,需要填写此值。
name
PassWordstring

用户密码。

说明 当 OpenSuperAcl 为 true 时,需要填写此值。
password
JuteMaxbufferstring

zookeeper 配置,每个节点最大数据量,默认是 1M,单位:字节。

1048575
AutopurgePurgeIntervalstring

保留字段。

none
AutopurgeSnapRetainCountstring

保留字段。

none
ConfigAuthEnabledboolean

nacos 配置,是否开启配置中心 ram 鉴权:

  • true:开启
  • false:关闭
说明 设置此值前需要调用 QueryConfig 接口,获取 ConfigAuthSupported 参数,以查看当前集群是否支持此功能。
true
NamingAuthEnabledboolean

nacos 配置,是否开启注册中心 ram 鉴权:

  • true:开启
  • false:关闭
说明 设置此值前需要调用 QueryConfig 接口,获取 NamingAuthSupporte 参数,以查看当前集群是否支持此功能。
true
MCPEnabledboolean

nacos 配置,MCP 是否生效,取值如下:

  • true:生效
  • false:不生效
说明 设置此值前需要调用 QueryConfig 接口,获取 MCPSupported 参数,以查看当前集群是否支持此功能。
true
InstanceIdstring

实例 ID。

mse_prepaid_public_cn-st2212****
ConfigSecretEnabledboolean

nacos 配置,是否打开配置中心配置加密功能,取值如下:

  • true:请求成功。
  • false:请求失败。
说明 设置此值前需要调用 QueryConfig 接口,获取 ConfigSecretSupported 参数,以查看当前集群是否支持此功能。
true
MinSessionTimeoutstring

zookeeper 配置,最小超时时间,单位:秒。

10
MaxSessionTimeoutstring

zookeeper 配置,最大超时时间,单位:秒。

1000
SnapshotCountstring

zookeeper 配置,生成快照的频率

100000
ExtendedTypesEnablestring

zookeeper 参数,是否开启 TTL 配置。

true
EurekaSupportedboolean

Nacos 是否开启支持 Eurka 协议

true
TLSEnabledboolean

Nacos 是否开启 TLS 传输链路加密

true
ConsoleUIEnabledboolean

是否开启 Nacos 开源控制台

true
Enable4lwboolean

是否开启四字命令访问

AuthEnabledboolean

是否启用强制 SASL 身份认证,启用之后,没有进行 SASL 身份认证的客户端将无法访问集群

AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

Messagestring

信息。

请求处理成功
RequestIdstring

请求 ID。

8BD1E58D-0755-42AC-A599-E6B55112****
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Codeinteger

返回码。

200
HttpStatusCodeinteger

HTTP 返回码。

200

示例

正常返回示例

JSON格式

{
  "Message": "请求处理成功",
  "RequestId": "8BD1E58D-0755-42AC-A599-E6B55112****",
  "Success": true,
  "Code": 200,
  "HttpStatusCode": 200
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterParameter error:%s请求参数错误:%s
400IllegalRequestInvalid request:%s非法请求: %s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-10-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-05-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-03-02OpenAPI 入参发生变更查看变更详情
2021-06-03OpenAPI 入参发生变更查看变更详情
2021-06-03新增 OpenAPI查看变更详情