QueryConfig查詢叢集配置API參考-微服務引擎-阿里雲

查詢叢集配置資訊。

調試

您可以在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	integer	單個配置的配置內容大小上限（單位：KB）。	100
NacosRunningEnv	object	nacos 運行時配置。
emptyProtect	boolean	推空保護開關。	true
grayAuth	string
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
Enable4lw	boolean	是否開啟四字命令	true
AuthEnabled	boolean	ZooKeeper sasl 強制身份認證開關	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": false,
    "NamingAuthSupported": true,
    "NamingCreateServiceSupported": true,
    "MinSessionTimeout": "-1",
    "MaxSessionTimeout": "-1",
    "SnapshotCount": "100000",
    "ConfigContentLimit": 100,
    "NacosRunningEnv": {
      "emptyProtect": true,
      "grayAuth": ""
    },
    "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
500	InternalError	Console error. Try again later:%s	控制台錯誤.稍後重試：%s
403	NoPermission	You are not authorized to perform this operation:%s	沒有許可權使用此介面：%s
404	NotFound	Not found:%s	資源不存在：%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。