QueryConfig - 查询集群配置

查询集群配置信息。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
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
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": true,
    "NamingAuthSupported": true,
    "NamingCreateServiceSupported": true,
    "MinSessionTimeout": "-1",
    "MaxSessionTimeout": "-1",
    "SnapshotCount": "100000",
    "ConfigContentLimit": 100,
    "NacosRunningEnv": {
      "emptyProtect": true
    },
    "ExtendedTypesEnable": true
  },
  "Success": true,
  "Code": 200,
  "HttpStatusCode": 200
}

错误码

Http code 错误码 错误信息 描述
400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
400 illegalRequest illegal request:%s 非法请求:%s
400 invalidParameter parameter error:%s 请求入参异常:%s
403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
404 clusterNotFound cluster not found 找不到此集群
500 systemError system error 系统开小差了,请稍后重试
500 regcenterError register center error:%s 注册配置中心请求错误:%s

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

变更历史

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