すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeParameterTemplates

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeParameterTemplates

    最終更新日:Jan 26, 2026

    MongoDB インスタンスのデフォルトパラメータテンプレートを照会します。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    Engine

    string

    必須

    データベースエンジン。 値を mongodb に設定します。

    mongodb
    EngineVersion

    string

    必須

    データベースのバージョン番号。有効な値：

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    5.0
    Role

    string

    任意

    インスタンスのロール。有効な値：

    • db: シャードクラスターインスタンスのシャードロール。

    • cs: シャードクラスターインスタンスのコンフィグサーバロール。

    • mongos: シャードクラスターインスタンスの mongos ロール。

    • normal: レプリカセットインスタンスのロール。

    • physical: シングルノードインスタンスのロール。

    デフォルト値は normal です。

    normal

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ParameterCount

    string

    パラメータの数。

    10
    EngineVersion

    string

    データベースのバージョン番号。

    5.0
    Parameters

    object

    TemplateRecord

    array<object>

    パラメータテンプレートのリスト。

    object

    CheckingCode

    string

    パラメータの有効な値。

    [0-65536]
    ParameterName

    string

    パラメータの名前。

    詳細については、「MongoDB 公式ドキュメント」をご参照ください。

    net.compression.compressors
    ParameterValue

    string

    パラメータのデフォルト値。

    100
    ForceModify

    boolean

    パラメータを変更できるかどうかを示します。

    • false: パラメータは変更できません。

    • true: パラメータは変更できます。

    true
    ForceRestart

    boolean

    パラメータの変更を有効にするために再起動が必要かどうかを示します。

    • false: 再起動は不要です。変更を送信すると、変更が有効になります。

    • true: 変更を有効にするには再起動が必要です。

    false
    ParameterDescription

    string

    パラメータの説明。

    The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
    RequestId

    string

    リクエスト ID。

    BDA54203-9D61-54A3-A568-D281F785****
    Engine

    string

    データベースエンジン。

    mongodb

    例

    成功レスポンス

    JSONJSON

    {
  "ParameterCount": "10",
  "EngineVersion": "5.0",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "net.compression.compressors",
        "ParameterValue": "100",
        "ForceModify": true,
        "ForceRestart": false,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100."
      }
    ]
  },
  "RequestId": "BDA54203-9D61-54A3-A568-D281F785****",
  "Engine": "mongodb"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidEngineVersion.Malformed Specified engine version is not valid.
    400 InvalidEngine.Malformed Specified engine is not valid.

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

    変更履歴

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