QueryConfig - Microservices Engine - Alibaba Cloud Documentation Center

Queries the configuration of a cluster.

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:QueryConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters in the JSON format.	{}
ClusterId	string	No	The ID of the cluster.	mse-09k1q11****
ConfigType	string	No	A reserved field.	null
InstanceId	string	No	The ID of the instance.	mse_prepaid_public_cn-st2212****
NeedRunningConf	boolean	No	Specifies whether to query the runtime configuration.	true
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 returned.	The request was successfully processed.
RequestId	string	The ID of the request.	8BD1E58D-0755-42AC-A599-E6B55112EC53
Data	object	The data overview.
MaxClientCnxns	string	The ZooKeeper configuration. This parameter indicates the number of connections between a client and a server. If this parameter is set to 0, no limit is imposed.	0
ConfigAuthSupported	boolean	The Nacos configuration. This parameter indicates whether the configuration center of the current cluster supports RAM authentication. Valid values: `true`: supported `false`: not supported	true
InitLimit	string	The ZooKeeper configuration. This parameter indicates the maximum connection duration of an instance. Unit: seconds.	100
MCPEnabled	boolean	The Nacos configuration. This parameter indicates whether Mesh Configuration Protocol (MCP) is enabled. Valid values: `true`: enabled `false`: disabled	true
OpenSuperAcl	boolean	The ZooKeeper configuration. This parameter indicates whether the super permission is enabled. Valid values: `true`: enabled `false`: disabled	true
RestartFlag	boolean	Indicates whether the cluster is restarted and the new configuration is applied. Valid values: `true`: The cluster is restarted. `false`: The cluster fails to be restarted.	true
JvmFlagsCustom	string	A reserved field.	none
AutopurgePurgeInterval	string	A reserved field.	none
AutopurgeSnapRetainCount	string	A reserved field.	none
SyncLimit	string	The ZooKeeper configuration. This parameter indicates the connection timeout duration of an instance. Unit: seconds.	10
ConfigAuthEnabled	boolean	The Nacos configuration. This parameter indicates whether RAM authentication is enabled for the configuration center. Valid values: `true`: enabled `false`: disabled	true
ClusterName	string	The name of the cluster.	name
MCPSupported	boolean	The Nacos configuration. This parameter indicates whether MCP is supported. Valid values: `true`: supported `false`: not supported	true
JuteMaxbuffer	string	The ZooKeeper configuration. This parameter indicates the maximum data size of each node. Unit: bytes.	1
TickTime	string	The ZooKeeper configuration. This parameter indicates a unit of time in the engine. The default value is 2000. Unit: milliseconds.	2000
PassWord	string	The password. This parameter is returned only when OpenSuperAcl is set to true.	password
UserName	string	The username. This parameter is returned only when OpenSuperAcl is set to true.	name
ConfigSecretSupported	boolean	The Nacos configuration. This parameter indicates whether the cluster supports configuration encryption. Valid values: `true`: supported `false`: not supported	true
ConfigSecretEnabled	boolean	The Nacos configuration. This parameter indicates whether configuration encryption is enabled for the cluster. Valid values: `true`: enabled `false`: disabled	true
NamingAuthEnabled	boolean	The Nacos configuration. This parameter indicates whether RAM authentication is enabled for the service registry. Valid values: `true`: enabled `false`: disabled	false
NamingAuthSupported	boolean	The Nacos configuration. This parameter indicates whether the cluster supports RAM authentication for services. Valid values: `true`: supported `false`: not supported	true
NamingCreateServiceSupported	boolean	The Nacos configuration. This parameter indicates whether the cluster supports service creation. Valid values: `true`: supported `false`: not supported	true
MinSessionTimeout	string	The ZooKeeper configuration. This parameter indicates the minimum timeout duration.	-1
MaxSessionTimeout	string	The ZooKeeper configuration. This parameter indicates the maximum timeout duration.	-1
SnapshotCount	string	The ZooKeeper configuration. This parameter indicates the frequency of generating snapshots.	100000
ConfigContentLimit	integer	The maximum size of the content of a single configuration. Unit: KB.	100
NacosRunningEnv	object	The runtime configuration of Nacos.
emptyProtect	boolean	The switch for push-empty protection.	true
grayAuth	string
ExtendedTypesEnable	boolean	The ZooKeeper parameter that specifies whether to enable the TTL configuration.	true
EurekaSupported	boolean	Specifies whether to enable port 8761 for access to the Eureka protocol. If you disable this port, applications cannot use the Eureka protocol for service registration and discovery.	true
TLSEnabled	boolean	MSE Nacos instances of version 2.1.2.1 or later support Transport Layer Security (TLS) encryption. The version of the Nacos client must be 2.2.1 or later. After you enable TLS, the performance may decrease by about 10%. You must evaluate the system capacity. For more information about the operations, see Nacos TLS transport encryption.	true
ConsoleUIEnabled	boolean	Specifies whether to enable the Nacos open source console.	true
Enable4lw	boolean	Specifies whether to enable the four-letter words command.
AuthEnabled	boolean	The switch for ZooKeeper SASL-based forced identity authentication.
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The result code returned.	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-E6B55112EC53",
  "Data": {
    "MaxClientCnxns": "0",
    "ConfigAuthSupported": true,
    "InitLimit": "100",
    "MCPEnabled": true,
    "OpenSuperAcl": true,
    "RestartFlag": true,
    "JvmFlagsCustom": "none",
    "AutopurgePurgeInterval": "none",
    "AutopurgeSnapRetainCount": "none",
    "SyncLimit": "10",
    "ConfigAuthEnabled": true,
    "ClusterName": "name",
    "MCPSupported": true,
    "JuteMaxbuffer": "1",
    "TickTime": "2000",
    "PassWord": "password",
    "UserName": "name",
    "ConfigSecretSupported": true,
    "ConfigSecretEnabled": true,
    "NamingAuthEnabled": false,
    "NamingAuthSupported": true,
    "NamingCreateServiceSupported": true,
    "MinSessionTimeout": "-1",
    "MaxSessionTimeout": "-1",
    "SnapshotCount": "100000",
    "ConfigContentLimit": 100,
    "NacosRunningEnv": {
      "emptyProtect": true,
      "grayAuth": ""
    },
    "ExtendedTypesEnable": true,
    "EurekaSupported": true,
    "TLSEnabled": true,
    "ConsoleUIEnabled": true,
    "Enable4lw": true,
    "AuthEnabled": true
  },
  "Success": true,
  "Code": 200,
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %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.