MSE QueryConfig API でクラスター構成詳細を取得 - MSE

クラスターの構成をクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:QueryConfig

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
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	返されたメッセージ。	The request was successfully processed.
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 の構成。このパラメーターは、Mesh Configuration Protocol (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	push-empty 保護のスイッチ。	true
grayAuth	string
ExtendedTypesEnable	boolean	TTL 構成を有効にするかどうかを指定する ZooKeeper パラメーター。	true
EurekaSupported	boolean	Eureka プロトコルへのアクセス用にポート 8761 を有効にするかどうかを指定します。このポートを無効にすると、アプリケーションはサービスの登録と検出に Eureka プロトコルを使用できなくなります。	true
TLSEnabled	boolean	バージョン 2.1.2.1 以後の MSE Nacos インスタンスは、Transport Layer Security (TLS) 暗号化をサポートしています。Nacos クライアントのバージョンは 2.2.1 以降である必要があります。TLS を有効にすると、パフォーマンスが約 10% 低下する可能性があります。システム容量を評価する必要があります。操作の詳細については、「Nacos TLS トランスポート暗号化」をご参照ください。	true
ConsoleUIEnabled	boolean	Nacos オープンソースコンソールを有効にするかどうかを指定します。	true
Enable4lw	boolean	4 文字のコマンドを有効にするかどうかを指定します。
AuthEnabled	boolean	ZooKeeper SASL ベースの強制身元認証のスイッチ。
Success	boolean	リクエストが成功したかどうかを示します。有効な値: `true`: リクエストは成功しました。 `false`: リクエストは失敗しました。	true
Code	integer	返された結果コード。	200
HttpStatusCode	integer	HTTP ステータスコード。	200

例

成功レスポンス

JSONJSON

{
  "Message": "The request was successfully processed.\n",
  "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 ステータスコード	エラーコード	エラーメッセージ
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。