UpdateConfig - Microservices Engine - Alibaba Cloud Documentation Center

Updates the configurations of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:UpdateConfig

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameter in the JSON format.	{}
ClusterId	string	No	The cluster ID.	mse-09k1q11****
ConfigType	string	No	The format of the configurations. Supported formats include TEXT, JSON, XML, and HTML.	TEXT
TickTime	string	No	The time unit. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.	2000
InitLimit	string	No	The maximum connection duration of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.	100
SyncLimit	string	No	The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.	10
MaxClientCnxns	string	No	The number of connections between a single client and a single server in ZooKeeper configuration. If this parameter is set to 0, no limits are imposed on the number of connections.	0
OpenSuperAcl	string	No	Specifies whether super permissions are enabled. This parameter is valid for ZooKeeper instances. Valid values: `true`: enabled `false`: disabled	true
UserName	string	No	The username of the account. Note This parameter is required when OpenSuperAcl is set to true.	name
PassWord	string	No	The password of the account. Note This parameter is required when OpenSuperAcl is set to true.	password
JuteMaxbuffer	string	No	The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. Unit: bytes.	1048575
AutopurgePurgeInterval	string	No	The reserved field.	none
AutopurgeSnapRetainCount	string	No	The reserved field.	none
ConfigAuthEnabled	boolean	No	Specifies whether to enable RAM authentication for the configuration center in Nacos: `true`: enabled `false`: disabled Note Before you set this parameter, call the QueryConfig operation to obtain the ConfigAuthSupported parameter to check whether the current cluster supports this feature.	true
NamingAuthEnabled	boolean	No	Specifies whether to enable RAM authentication for the Accreditation Centre in Nacos: `true`: enabled `false`: disabled Note Before you set this parameter, call the QueryConfig operation to obtain the NamingAuthSupporte parameter to check whether the current cluster supports this feature.	true
MCPEnabled	boolean	No	Specifies whether MCP is enabled in Nacos configuration. Valid values: `true`: enabled `false`: disabled Note Before you set this parameter, call the QueryConfig operation to obtain the MCPSupported parameter to check whether the current cluster supports this feature.	true
InstanceId	string	No	The instance ID.	mse_prepaid_public_cn-st2212****
ConfigSecretEnabled	boolean	No	Specifies whether to enable the configuration encryption feature for the configuration center in Nacos. Valid values: `true`: The request was successful. `false`: The request failed. Note Before you set this parameter, call the QueryConfig operation to obtain the ConfigSecretSupported parameter to check whether the current cluster supports this feature.	true
MinSessionTimeout	string	No	The minimum timeout period in ZooKeeper configuration. Unit: seconds.	10
MaxSessionTimeout	string	No	The maximum timeout period in ZooKeeper configuration. Unit: seconds.	1000
SnapshotCount	string	No	The frequency at which snapshots are generated in ZooKeeper configuration	100000
ExtendedTypesEnable	string	No	Specifies whether to enable TTL configuration in ZooKeeper parameters.	true
EurekaSupported	boolean	No	Specifies whether to enable Eureka protocol support in Nacos	true
TLSEnabled	boolean	No	Specifies whether to enable TLS transmission link encryption in Nacos	true
ConsoleUIEnabled	boolean	No	Specifies whether to enable the Nacos open-source console
Enable4lw	boolean	No	Specifies whether to enable the four-character command access feature
AuthEnabled	boolean	No	Specifies whether to enable forced Simple Authentication and Security Layer (SASL) authentication. After this feature is enabled, clients that do not perform SASL authentication cannot access the cluster
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
Message	string	The message.	The request was successfully processed.
RequestId	string	The request ID.	8BD1E58D-0755-42AC-A599-E6B55112****
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The return code.	200
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "Message": "The request was successfully processed.\n",
  "RequestId": "8BD1E58D-0755-42AC-A599-E6B55112****",
  "Success": true,
  "Code": 200,
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
400	IllegalRequest	Invalid request:%s	Invalid request: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.