DescribeParameters - MongoDB

ApsaraDB for MongoDB インスタンスのパラメーター設定を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeParameters

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。説明このパラメーターをシャードクラスターインスタンスの ID に設定する場合は、NodeId パラメーターも指定する必要があります。	dds-bpxxxxxxxx
NodeId	string	任意	指定されたシャードクラスターインスタンス内の Mongos ノードまたはシャードノードの ID。説明このパラメーターは、DBInstanceId パラメーターがシャードクラスターインスタンスの ID に設定されている場合に有効です。	d-bpxxxxxxxx
CharacterType	string	任意	インスタンスのロール。有効な値： db：シャードノード。 cs：ConfigServer ノード。 mongos：Mongos ノード。	mongos
ExtraParam	string	任意	将来利用可能になるパラメーター。	terrform

レスポンスフィールド

フィールド	型	説明	例
	object
RunningParameters	object
Parameter	array<object>	有効になっているパラメーターの設定。
	object
CheckingCode	string	パラメーターの有効な値。	[33554432-268435456]
ParameterName	string	パラメーターの名前。	setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValue	string	パラメーターの値。	33554432
ForceRestart	string	パラメーターの変更を有効にするために再起動が必要かどうかを示します。有効な値： false：再起動は不要です。変更はすぐに有効になります。 true：パラメーターの変更を有効にするには再起動が必要です。	false
ParameterDescription	string	パラメーターの説明。	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatus	string	パラメーター値を変更できるかどうかを示します。有効な値： false：パラメーター値は変更できません。 true：パラメーター値は変更できます。	true
CharacterType	string	インスタンスのロールタイプ。有効な値は次のとおりです。 db：シャードノード。 cs：ConfigServer ノード。 mongos：Mongos ノード。	db
EngineVersion	string	インスタンスのデータベースエンジンバージョン。	4.0
RequestId	string	リクエスト ID。	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	設定テンプレート内のパラメーター設定。
	object
CheckingCode	string	パラメーターの有効な値。	[0-65536]
ParameterName	string	パラメーターの名前。	operationProfiling.slowOpThresholdMs
ParameterValue	string	パラメーターの値。	200
ForceRestart	boolean	パラメーターの変更を有効にするために再起動が必要かどうかを示します。有効な値： false：再起動は不要です。変更はすぐに有効になります。 true：パラメーターの変更を有効にするには再起動が必要です。	true
ParameterDescription	string	パラメーターの説明。	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatus	boolean	パラメーター値を変更できるかどうかを示します。有効な値： false：パラメーター値は変更できません。 true：パラメーター値は変更できます。	true
Engine	string	インスタンスのデータベースエンジン。デフォルト値：mongodb。	mongodb

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	The specified DB instance type is not found.

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

変更履歴

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