All Products
Search

This Product

    Microservices Engine:UpdateConfig

    Document Center

    Microservices Engine:UpdateConfig

    Last Updated:Aug 12, 2024

    Updates the configurations of an instance.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    mse:UpdateConfigupdate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RequestParsstringNo

    The extended request parameters in the JSON format.

    		{}
    ClusterIdstringYes

    The ID of the cluster.

    		mse-09k1q11****
    ConfigTypestringYes

    The format of the configuration. Supported formats include TEXT, JSON, XML, and HTML.

    		TEXT
    TickTimestringYes

    The time unit. This parameter is valid for ZooKeeper instances. Default value: 2000. Unit: milliseconds.

    		2000
    InitLimitstringYes

    The maximum connection duration of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.

    		100
    SyncLimitstringYes

    The connection timeout period of the instance. This parameter is valid for ZooKeeper instances. Unit: seconds.

    		10
    MaxClientCnxnsstringYes

    The number of connections between a client and a server. This parameter is valid for ZooKeeper instances.
    If this parameter is set to 0, no limits are imposed on the number of connections.

    		0
    OpenSuperAclstringYes

    Specifies whether to enable super permissions. This parameter is valid for ZooKeeper instances. Valid values:

    • true: enabled
    • false: disabled
    		true
    UserNamestringNo

    The name of the user.

    Note You must specify this parameter if OpenSuperAcl is set to true.
    		name
    PassWordstringNo

    The password that corresponds to the username.

    Note You must specify this parameter if OpenSuperAcl is set to true.
    		password
    JuteMaxbufferstringYes

    The maximum amount of data on each node. This parameter is valid for ZooKeeper instances. The default maximum data amount on each node is 1 megabyte. Unit: bytes.

    		1048575
    AutopurgePurgeIntervalstringYes

    A reserved parameter.

    		none
    AutopurgeSnapRetainCountstringYes

    A reserved parameter.

    		none
    ConfigAuthEnabledbooleanNo

    Specifies whether to enable Resource Access Management (RAM) authentication for a configuration center. This parameter is valid for Nacos instances. Valid values:

    • true: enabled.
    • false: disabled.
    Note Before you configure this parameter, you must call the QueryConfig operation to obtain the ConfigAuthSupported parameter value to check whether the instance supports the RAM authentication feature.
    		true
    NamingAuthEnabledbooleanNo

    Specifies whether to enable RAM authentication for a registry. This parameter is valid for Nacos instances. Valid values:

    • true: enabled.
    • false: disabled.
    Note Before you configure this parameter, you must call the QueryConfig operation to obtain the NamingAuthSupporte parameter value to check whether the instance supports the RAM authentication feature.
    		true
    MCPEnabledbooleanNo

    Specifies whether to enable Mesh Configuration Protocol (MCP). This parameter is valid for Nacos instances. Valid values:

    • true: enabled.
    • false: disabled.
    Note Before you configure this parameter, you must call the QueryConfig operation to obtain the MCPSupported parameter value to check whether the instance supports MCP.
    		true
    InstanceIdstringNo

    The ID of the instance.

    		mse_prepaid_public_cn-st2212****
    ConfigSecretEnabledbooleanNo

    Specifies whether to enable configuration encryption for a configuration center. This parameter is valid for Nacos instances. Valid values:

    • true: enabled.
    • false: disabled.
    Note Before you configure this parameter, you must call the QueryConfig operation to obtain the ConfigSecretSupported parameter value to check whether the instance supports configuration encryption.
    		true
    MinSessionTimeoutstringNo

    The minimum timeout period. This parameter is valid for ZooKeeper instances. Unit: seconds.

    		10
    MaxSessionTimeoutstringNo

    The maximum timeout period. This parameter is valid for ZooKeeper instances. Unit: seconds.

    		1000
    SnapshotCountstringNo

    The frequency for generating snapshots. This parameter is valid for ZooKeeper instances.

    		100000
    ExtendedTypesEnablestringNo

    Specifies whether to enable the time to live (TTL) configuration. This parameter is valid for ZooKeeper instances.

    		true
    AcceptLanguagestringNo

    The language of the response. Valid values:

    • zh: Chinese
    • en: English
    		zh

    Response parameters

    ParameterTypeDescriptionExample
    object

    The data structure.

    Messagestring

    The message returned.

    		The request was successfully processed.
    RequestIdstring

    The ID of the request.

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

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    Codeinteger

    The status code returned.

    		200
    HttpStatusCodeinteger

    The HTTP status code returned.

    		200

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterParameter error:%sRequest parameter error: %s
    400IllegalRequestInvalid request:%sInvalid request: %s
    403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
    404NotFoundNot found:%sThe resource does not exist:%s
    500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-06-12The Error code has changed. The request parameters of the API has changedView Change Details
    2023-10-19The Error code has changed. The request parameters of the API has changedView Change Details
    2023-05-08The Error code has changed. The request parameters of the API has changedView Change Details
    2023-03-02The request parameters of the API has changedView Change Details
    2021-06-03The request parameters of the API has changedView Change Details
    2021-06-03Add OperationView Change Details