首页 微服务引擎MSE API参考指南 API目录 注册配置中心 集群管理 QueryConfig - 查询集群配置

QueryConfig - 查询集群配置

查询集群配置信息。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RequestParsstring否

扩展请求参数，JSON格式。

{}
ClusterIdstring是

集群ID。

mse-09k1q11****
ConfigTypestring否

预留字段。

null
InstanceIdstring是

实例ID。

mse_prepaid_public_cn-st2212****
NeedRunningConfboolean否

是否需要运行时配置。

true
AcceptLanguagestring否

返回信息的语言类型：

  • zh：中文
  • en：英文
zh

返回参数

名称类型描述示例值
object

数据结构。

Messagestring

信息。

请求处理成功
RequestIdstring

请求ID。

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

数据概览。

MaxClientCnxnsstring

zookeeper配置，单个客户端与单台服务器之间的连接数。
如果设置为0，表示不作任何限制。

0
ConfigAuthSupportedboolean

nacos配置，当前集群的配置中心是否支持ram鉴权，取值如下：

  • true：支持
  • false：不支持
true
InitLimitstring

zookeeper配置，实例最长连接时间，单位：秒。

100
MCPEnabledboolean

nacos配置，MCP是否生效，取值如下：

  • true：生效
  • false：不生效
true
OpenSuperAclboolean

zookeeper配置，超级权限开关，取值如下：

  • true：打开
  • false：关闭
true
RestartFlagboolean

当前集群是否已重启并应用新配置，取值如下：

  • true：重启成功。
  • false：重启失败。
true
JvmFlagsCustomstring

保留字段

none
AutopurgePurgeIntervalstring

保留字段。

none
AutopurgeSnapRetainCountstring

保留字段。

none
SyncLimitstring

zookeeper配置，实例连接超时时间，单位：秒。

10
ConfigAuthEnabledboolean

nacos配置，是否开启配置中心ram鉴权，取值如下：

  • true：生效
  • false：未生效
true
ClusterNamestring

集群名称。

name
MCPSupportedboolean

nacos配置，MCP是否支持，取值如下：

  • true：支持
  • false：不支持
true
JuteMaxbufferstring

zookeeper配置，每个节点最大数据量，单位：字节。

1
TickTimestring

zookeeper配置，引擎中的一个时间单元，默认为2000毫秒。

2000
PassWordstring

用户密码。当OpenSuperAcl为true时，展示此值。

password
UserNamestring

用户名称。当OpenSuperAcl为true时，展示此值。

name
ConfigSecretSupportedboolean

nacos配置，当前集群是否支持配置中心配置加密，取值如下：

  • true：支持
  • false：不支持
true
ConfigSecretEnabledboolean

nacos配置，当前集群是否开启配置中心配置加密，取值如下：

  • true：开启
  • false：未开启
true
NamingAuthEnabledboolean

nacos配置，是否开启注册中心ram鉴权：

  • true：开启
  • false：关闭
false
NamingAuthSupportedboolean

nacos配置，当前集群是否支持服务ram鉴权，取值如下：

  • true：支持
  • false：不支持
true
NamingCreateServiceSupportedboolean

nacos配置，当前集群是否支持创建服务，取值如下：

  • true：支持
  • false：不支持
true
MinSessionTimeoutstring

zookeeper配置，最小超时时间。

-1
MaxSessionTimeoutstring

zookeeper配置，最大超时时间。

-1
SnapshotCountstring

zookeeper配置，生成快照的频率

100000
ConfigContentLimitlong

单个配置的配置内容大小上限（单位：KB）。

100
NacosRunningEnvobject

nacos运行时配置。

emptyProtectboolean

推空保护开关。

true
ExtendedTypesEnableboolean

zookeeper参数，是否开启TTL配置。

true
Successboolean

请求结果，取值如下：

  • true：请求成功。
  • false：请求失败。
true
Codeinteger

返回结果码。

200
HttpStatusCodeinteger

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

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求： %s
400InvalidParameterParameter error:%s请求参数错误：%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口：%s
404NotFoundNot found:%s资源不存在：%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试：%s

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

变更历史

变更时间变更内容概要操作
2021-06-03新增 OpenAPI
阿里云首页 微服务引擎 相关技术圈