All Products
Search
Document Center

Microservices Engine:QueryConfig

Last Updated:Feb 20, 2024

Queries configuration information 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:QueryConfigRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The extended request parameters in the JSON format.

{}
ClusterIdstringYes

The ID of the cluster.

mse-09k1q11****
ConfigTypestringNo

A reserved parameter.

null
InstanceIdstringYes

The ID of the instance.

mse_prepaid_public_cn-st2212****
NeedRunningConfbooleanNo

Specifies whether runtime configurations are required.

true
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Messagestring

The message returned.

The request was successfully processed.
RequestIdstring

The ID of the request.

8BD1E58D-0755-42AC-A599-E6B55112EC53
Dataobject

The details of the data.

MaxClientCnxnsstring

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
ConfigAuthSupportedboolean

Indicates whether RAM authentication is supported by a configuration center of the instance. This parameter is valid for Nacos instances. Valid values:

  • true: supported.
  • false: not supported.
true
InitLimitstring

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

100
MCPEnabledboolean

Indicates whether Mesh Configuration Protocol (MCP) is enabled. This parameter is valid for Nacos instances. Valid values:

  • true: enabled.
  • false: disabled.
true
OpenSuperAclboolean

Indicates whether super permissions are enabled. This parameter is valid for ZooKeeper instances. Valid values:

  • true: enabled.
  • false: disabled.
true
RestartFlagboolean

Indicates whether the instance was restarted and new configurations have taken effect. Valid values:

  • true: The restart was successful.
  • false: The restart failed.
true
JvmFlagsCustomstring

A reserved parameter.

none
AutopurgePurgeIntervalstring

A reserved parameter.

none
AutopurgeSnapRetainCountstring

A reserved parameter.

none
SyncLimitstring

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

10
ConfigAuthEnabledboolean

Indicates whether RAM authentication of a configuration center is enabled. This parameter is valid for Nacos instances. Valid values:

  • true: enabled.
  • false: disabled.
true
ClusterNamestring

The name of the instance.

name
MCPSupportedboolean

Indicates whether MCP is supported. This parameter is valid for Nacos instances. Valid values:

  • true: supported.
  • false: not supported.
true
JuteMaxbufferstring

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

1
TickTimestring

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

2000
PassWordstring

The password that corresponds to the username. This parameter is valid only if OpenSuperAcl is set to true.

password
UserNamestring

The username of the user. This parameter is valid only if OpenSuperAcl is set to true.

name
ConfigSecretSupportedboolean

Indicates whether configuration encryption of a configuration center is supported by the instance. This parameter is valid for Nacos instances. Valid values:

  • true: supported.
  • false: not supported.
true
ConfigSecretEnabledboolean

Indicates whether configuration encryption of a configuration center is enabled by the instance. This parameter is valid for Nacos instances. Valid values:

  • true: enabled.
  • false: disabled.
true
NamingAuthEnabledboolean

Indicates whether RAM authentication of a registry is enabled. This parameter is valid for Nacos instances. Valid values:

  • true: enabled.
  • false: disabled.
false
NamingAuthSupportedboolean

Indicates whether RAM authentication of services is supported by the instance. This parameter is valid for Nacos instances. Valid values:

  • true: supported.
  • false: not supported.
true
NamingCreateServiceSupportedboolean

Indicates whether service creation is supported for the instance. This parameter is valid for Nacos instances. Valid values:

  • true: supported.
  • false: not supported.
true
MinSessionTimeoutstring

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

-1
MaxSessionTimeoutstring

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

-1
SnapshotCountstring

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

100000
ConfigContentLimitlong

The maximum size of contents in a configuration. Unit: KB.

100
NacosRunningEnvobject

The runtime configuration of the Nacos instance.

emptyProtectboolean

Indicates whether empty list protection is enabled.

true
ExtendedTypesEnableboolean

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

true
EurekaSupportedboolean

Indicates whether access port 8761 was enabled for Eureka. If this port is disabled, applications cannot use the Eureka protocol for service registration and discovery.

true
TLSEnabledboolean

MSE Nacos supports TLS transmission link encryption since version 2.1.2.1. Nacos clients must be upgraded to version 2.2.1 or later. After TLS is enabled, the system performance will decrease by about 10%. You must evaluate the system capacity. For more information about the relevant operations, see Nacos TLS transmission encryption.

true
ConsoleUIEnabledboolean

Indicates whether the Nacos open source console is enabled.

true
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-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
    },
    "ExtendedTypesEnable": true,
    "EurekaSupported": true,
    "TLSEnabled": true,
    "ConsoleUIEnabled": true
  },
  "Success": true,
  "Code": 200,
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %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
2023-10-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
2023-05-08The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 403
    Added Error Codes: 404
    Added Error Codes: 500
Output ParametersThe response structure of the API has changed.
2023-03-02The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-03-02The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-06-03Add Operationsee changesets