文档

QueryConfig - 查询集群配置

更新时间:

查询集群配置信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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
EurekaSupportedboolean

是否打开 Eureka 协议的访问端口 8761。关闭此端口,应用将无法使用 Eureka 协议进行服务注册发现。

true
TLSEnabledboolean

MSE Nacos 从 2.1.2.1 版本开始支持 TLS 传输链路加密,nacos-client 需升级至 2.2.1 及以上版本,开启 TLS 后,会有 10%左右性能下降,请合理评估系统容量水位,操作指引详见 Nacos TLS 传输加密.

true
ConsoleUIEnabledboolean

是否开始 Nacos 开源控制台

true
AuthEnabledboolean

ZooKeeper sasl 强制身份认证开关

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,
    "TLSEnabled": true,
    "ConsoleUIEnabled": true,
    "Enable4lw": true,
    "AuthEnabled": 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

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

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-05-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
    新增错误码:404
    新增错误码:500
出参OpenAPI 返回结构发生变更
2023-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-06-03新增 OpenAPI看变更集
  • 本页导读 (1)