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

デバッグ

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

リクエストパラメータ


パラメータ	データ型	必須	例	説明
Action	String	はい	DescribeParameters	実行する操作。値を DescribeParameters に設定します。
DBInstanceId	String	はい	dds-bpxxxxxxxx	インスタンスの ID 注このパラメーターをシャードクラスターインスタンスの ID に指定する場合は、 NodeId パラメータを指定する必要があります。
NodeId	String	いいえ	d-bpxxxxxxxx	指定されたシャードクラスターインスタンス内の mongos またはシャードの ID。注このパラメーターは、シャードクラスターインスタンスの ID に DBInstanceId パラメーターを指定した場合にのみ有効です。
AccessKeyId	String	いいえ	LTAIgbTGpxxxxxx	Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ


パラメータ	タイプ	例	説明
ConfigParameters			構成済みパラメータのリストとその詳細。
└CheckingCode	String	[0-65536]	パラメータ値の範囲。
└ForceRestart	Boolean	true	パラメータの変更を有効にするために再起動が必要かどうかを示します。 false ：再起動不要。変更は、行われた直後に有効になります。 ture：再起動必要。
└ModifiableStatus	Boolean	true	パラメータが変更可能かどうかを示します。 false true
└ParameterDescription	String	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.	パラメーターの説明。
└ParameterName	String	operationProfiling.slowOpThresholdMs	パラメータの名前。
└ParameterValue	String	200	パラメータの値。
RequestId	String	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8	リクエストの ID です。
RunningParameters			実行パラメーターの構成。
└CheckingCode	String	[33554432-268435456]	パラメータ値の範囲。
└ForceRestart	Boolean	false	パラメータの変更を有効にするために再起動が必要かどうかを示します。 false ：再起動不要。変更は、行われた直後に有効になります。 ture：再起動必要。
└ModifiableStatus	Boolean	true	パラメーターが変更可能かどうかを示します。 false true
└ParameterDescription	String	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)	パラメーターの説明。
└ParameterName	String	setParameter.internalQueryExecMaxBlockingSortBytes	パラメータの名前。
└ParameterValue	String	33554432	パラメータの値。
EngineVersion	String	4.0	データベースのバージョン番号。
Engine	String	mongodb	データベースエンジン。デフォルト値： mongodb。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=DescribeParameters
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

通常のレスポンスの例

XML 形式

<DescribeParametersResponse>
  <ConfigParameters>
    <Parameter>
      <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100. </ParameterDescription>
      <ParameterValue>200</ParameterValue>
      <CheckingCode>[0-65536]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
    </Parameter>
  </ConfigParameters>
  <RequestId>3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8</RequestId>
  <RunningParameters>
    <Parameter>
      <ParameterDescription/>
      <ParameterValue>zlib</ParameterValue>
      <CheckingCode>snappy|zlib|disabled</CheckingCode>
      <ForceRestart>true</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>net.compression.compressors</ParameterName>
    </Parameter>
    <Parameter>
      <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>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>operationProfiling.mode</ParameterName>
    </Parameter>
    <Parameter>
      <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100. </ParameterDescription>
      <ParameterValue>220</ParameterValue>
      <CheckingCode>[0-65536]</CheckingCode>
      <ForceRestart>false</ForceRestart>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
    </Parameter>
    <Parameter>
      <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>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>setParameter.cursorTimeoutMillis</ParameterName>
    </Parameter>
    <Parameter>
      <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>
      <ModifiableStatus>true</ModifiableStatus>
      <ParameterName>setParameter.internalQueryExecMaxBlockingSortBytes</ParameterName>
    </Parameter>
  </RunningParameters>
  <EngineVersion>4.0</EngineVersion>
  <Engine>mongodb</Engine>
</DescribeParametersResponse>

JSON 形式

{
	"ConfigParameters":{
		"Parameter":[
			{
				"ParameterDescription":"The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
				"ParameterValue":"200",
				"ForceRestart":false,
				"CheckingCode":"[0-65536]",
				"ModifiableStatus":true,
				"ParameterName":"operationProfiling.slowOpThresholdMs"
			}
		]
	},
	"RequestId":"3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
	"RunningParameters":{
		"Parameter":[
			{
				"ParameterDescription":"",
				"ParameterValue":"zlib",
				"ForceRestart":"true",
				"CheckingCode":"snappy|zlib|disabled",
				"ModifiableStatus":"true",
				"ParameterName":"net.compression.compressors"
			},
			{
				"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",
				"ModifiableStatus":"true",
				"ParameterName":"operationProfiling.mode"
			},
			{
				"ParameterDescription":"The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
				"ParameterValue":"220",
				"ForceRestart":"false",
				"CheckingCode":"[0-65536]",
				"ModifiableStatus":"true",
				"ParameterName":"operationProfiling.slowOpThresholdMs"
			},
			{
				"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]",
				"ModifiableStatus":"true",
				"ParameterName":"setParameter.cursorTimeoutMillis"
			},
			{
				"ParameterDescription":"The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
				"ParameterValue":"33554432",
				"ForceRestart":"false",
				"CheckingCode":"[33554432-268435456]",
				"ModifiableStatus":"true",
				"ParameterName":"setParameter.internalQueryExecMaxBlockingSortBytes"
			}
		]
	},
	"EngineVersion":"4.0",
	"Engine":"mongodb"
}

エラーコード


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBInstanceClass.NotFound	指定された DB インスタンスクラスが見つかりません。	指定されたインスタンスタイプが存在しない場合に表示されるエラーメッセージ。指定されたインスタンスタイプをご確認ください。
403	IncorrectDBInstanceType	現行 DB インスタンスタイプはこの API をサポートしていません。	現行 API が指定されたインスタンスのタイプでサポートされていない場合に返されるエラーメッセージ。

エラーコードの表示