如何调用QueryConfig查询集群配置_微服务引擎(MSE)-阿里云帮助中心

查询集群配置信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:QueryConfig	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RequestPars	string	否	扩展请求参数，JSON 格式。	{}
ClusterId	string	是	集群 ID。	mse-09k1q11****
ConfigType	string	否	预留字段。	null
InstanceId	string	是	实例 ID。	mse_prepaid_public_cn-st2212****
NeedRunningConf	boolean	否	是否需要运行时配置。	true
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	数据结构。
Message	string	信息。	请求处理成功
RequestId	string	请求 ID。	8BD1E58D-0755-42AC-A599-E6B55112EC53
Data	object	数据概览。
MaxClientCnxns	string	zookeeper 配置，单个客户端与单台服务器之间的连接数。如果设置为 0，表示不作任何限制。	0
ConfigAuthSupported	boolean	nacos 配置，当前集群的配置中心是否支持 RAM 鉴权，取值如下： `true`：支持 `false`：不支持	true
InitLimit	string	zookeeper 配置，实例最长连接时间，单位：秒。	100
MCPEnabled	boolean	nacos 配置，MCP 是否生效，取值如下： `true`：生效 `false`：不生效	true
OpenSuperAcl	boolean	zookeeper 配置，超级权限开关，取值如下： `true`：打开 `false`：关闭	true
RestartFlag	boolean	当前集群是否已重启并应用新配置，取值如下： `true`：重启成功。 `false`：重启失败。	true
JvmFlagsCustom	string	保留字段	none
AutopurgePurgeInterval	string	保留字段。	none
AutopurgeSnapRetainCount	string	保留字段。	none
SyncLimit	string	zookeeper 配置，实例连接超时时间，单位：秒。	10
ConfigAuthEnabled	boolean	nacos 配置，是否开启配置中心 ram 鉴权，取值如下： `true`：生效 `false`：未生效	true
ClusterName	string	集群名称。	name
MCPSupported	boolean	nacos 配置，MCP 是否支持，取值如下： `true`：支持 `false`：不支持	true
JuteMaxbuffer	string	zookeeper 配置，每个节点最大数据量，单位：字节。	1
TickTime	string	zookeeper 配置，引擎中的一个时间单元，默认为 2000 毫秒。	2000
PassWord	string	用户密码。当 OpenSuperAcl 为 true 时，展示此值。	password
UserName	string	用户名称。当 OpenSuperAcl 为 true 时，展示此值。	name
ConfigSecretSupported	boolean	nacos 配置，当前集群是否支持配置中心配置加密，取值如下： `true`：支持 `false`：不支持	true
ConfigSecretEnabled	boolean	nacos 配置，当前集群是否开启配置中心配置加密，取值如下： `true`：开启 `false`：未开启	true
NamingAuthEnabled	boolean	nacos 配置，是否开启注册中心 ram 鉴权： `true`：开启 `false`：关闭	false
NamingAuthSupported	boolean	nacos 配置，当前集群是否支持服务 RAM 鉴权，取值如下： `true`：支持 `false`：不支持	true
NamingCreateServiceSupported	boolean	nacos 配置，当前集群是否支持创建服务，取值如下： `true`：支持 `false`：不支持	true
MinSessionTimeout	string	zookeeper 配置，最小超时时间。	-1
MaxSessionTimeout	string	zookeeper 配置，最大超时时间。	-1
SnapshotCount	string	zookeeper 配置，生成快照的频率	100000
ConfigContentLimit	long	单个配置的配置内容大小上限（单位：KB）。	100
NacosRunningEnv	object	nacos 运行时配置。
emptyProtect	boolean	推空保护开关。	true
ExtendedTypesEnable	boolean	zookeeper 参数，是否开启 TTL 配置。	true
EurekaSupported	boolean	是否打开 Eureka 协议的访问端口 8761。关闭此端口，应用将无法使用 Eureka 协议进行服务注册发现。	true
TLSEnabled	boolean	MSE Nacos 从 2.1.2.1 版本开始支持 TLS 传输链路加密，nacos-client 需升级至 2.2.1 及以上版本，开启 TLS 后，会有 10%左右性能下降，请合理评估系统容量水位，操作指引详见 Nacos TLS 传输加密.	true
ConsoleUIEnabled	boolean	是否开始 Nacos 开源控制台	true
AuthEnabled	boolean	ZooKeeper sasl 强制身份认证开关
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Code	integer	返回结果码。	200
HttpStatusCode	integer	HTTP 状态码。	200

示例

正常返回示例

JSON格式

{
  "Message": "请求处理成功",
  "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,
    "Enable4lw": true,
    "AuthEnabled": true
  },
  "Success": true,
  "Code": 200,
  "HttpStatusCode": 200
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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

变更历史

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