DescribeParameterTemplates - - Alibaba Cloud ドキュメントセンター

この API を呼び出して、ApsaraDB for MongoDB インスタンスのデフォルトパラメータテンプレートのリストをクエリできます。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ	データ型	必須	例	説明
Action	String	はい	DescribeParameterTemplates	実行する操作。値を DescribeParameterTemplates に設定します。
Engine	String	はい	mongodb	データベースエンジン。値を mongodb に設定します。
EngineVersion	String	はい	4.0	データベースのバージョン番号。有効値： 3.2 、 3.4、 4.0 。
AccessKeyId	String	いいえ	LTAI****************	Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ

パラメータ	タイプ	例	説明
Parameters			パラメータテンプレート。
└CheckingCode	String	[0-65536]	パラメータ値の範囲。
└ForceModify	Boolean	true	パラメーターが変更可能かどうかを示します。 false true
└ForceRestart	Boolean	false	パラメータの変更を有効にするために再起動が必要かどうかを示します。 false ：再起動不要。変更は、行われた直後に有効になります。 ture：再起動必要。
└ParameterDescription	String	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.	パラメーターの説明。
└ParameterName	String	operationProfiling.slowOpThresholdMs	パラメータの名前。
└ParameterValue	String	100	パラメータのデフォルト値。
RequestId	String	76B66D95-0670-4199-A8B1-E362286CD015	リクエスト ID。
ParameterCount	String	5	パラメータの数。
EngineVersion	String	4.0	データベースのバージョン番号。
Engine	String	mongodb	データベースエンジン。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=DescribeParameterTemplates
&Engine=mongodb
&EngineVersion=4.0
&<Common request parameters>

通常のレスポンスの例

XML 形式

<DescribeParameterTemplatesResponse>
  <Parameters>
    <TemplateRecord>
      <ForceModify>true</ForceModify>
      <ParameterDescription/>
      <ParameterValue>slowOp</ParameterValue>
      <CheckingCode>snappy|zlib|disabled</CheckingCode>
      <ForceRestart>true</ForceRestart>
      <ParameterName>net.compression.compressors</ParameterName>
    </TemplateRecord>
    <TemplateRecord>
      <ForceModify>true</ForceModify>
      <ParameterDescription>The level of database profiling, which inserts information about operation performance into the system.profile collection. 'off' for no profiling, 'slowOp' for only includes slow operations, 'all' for includes all operations, default is 'slowOp'. </ParameterDescription>
      <ParameterValue>slowOp</ParameterValue>
      <CheckingCode>off|slowOp|all</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ParameterName>operationProfiling.mode</ParameterName>
    </TemplateRecord>
    <TemplateRecord>
      <ForceModify>true</ForceModify>
      <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100. </ParameterDescription>
      <ParameterValue>100</ParameterValue>
      <CheckingCode>[0-65536]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
    </TemplateRecord>
    <TemplateRecord>
      <ForceModify>true</ForceModify>
      <ParameterDescription>The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)</ParameterDescription>
      <ParameterValue>600000</ParameterValue>
      <CheckingCode>[1-2147483647]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ParameterName>setParameter.cursorTimeoutMillis</ParameterName>
    </TemplateRecord>
    <TemplateRecord>
      <ForceModify>true</ForceModify>
      <ParameterDescription>The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)</ParameterDescription>
      <ParameterValue>33554432</ParameterValue>
      <CheckingCode>[33554432-268435456]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ParameterName>setParameter.internalQueryExecMaxBlockingSortBytes</ParameterName>
    </TemplateRecord>
  </Parameters>
  <RequestId>76B66D95-0670-4199-A8B1-E362286CD015</RequestId>
  <ParameterCount>5</ParameterCount>
  <EngineVersion>4.0</EngineVersion>
  <Engine>mongodb</Engine>
</DescribeParameterTemplatesResponse>

JSON 形式

{
	"Parameters":{
		"TemplateRecord":[
			{
				"ForceModify":true,
				"ParameterDescription":"",
				"ParameterValue":"snappy",
				"ForceRestart":true,
				"CheckingCode":"snappy|zlib|disabled",
				"ParameterName":"net.compression.compressors"
			},
			{
				"ForceModify":true,
				"ParameterDescription":"The level of database profiling, which inserts information about operation performance into the system.profile collection. 'off' for no profiling, 'slowOp' for only includes slow operations, 'all' for includes all operations, default is 'slowOp'.",
				"ParameterValue":"slowOp",
				"ForceRestart":false,
				"CheckingCode":"off|slowOp|all",
				"ParameterName":"operationProfiling.mode"
			},
			{
				"ForceModify":true,
				"ParameterDescription":"The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
				"ParameterValue":"100",
				"ForceRestart":false,
				"CheckingCode":"[0-65536]",
				"ParameterName":"operationProfiling.slowOpThresholdMs"
			},
			{
				"ForceModify":true,
				"ParameterDescription":"The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)",
				"ParameterValue":"600000",
				"ForceRestart":false,
				"CheckingCode":"[1-2147483647]",
				"ParameterName":"setParameter.cursorTimeoutMillis"
			},
			{
				"ForceModify":true,
				"ParameterDescription":"The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
				"ParameterValue":"33554432",
				"ForceRestart":false,
				"CheckingCode":"[33554432-268435456]",
				"ParameterName":"setParameter.internalQueryExecMaxBlockingSortBytes"
			}
		]
	},
	"RequestId":"76B66D95-0670-4199-A8B1-E362286CD015",
	"ParameterCount":"5",
	"EngineVersion":"4.0",
	"Engine":"mongodb"
}

エラーコード

エラーコードの表示