すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:ModifyParameters

最終更新日:Oct 15, 2025

ApsaraDB for MongoDB インスタンスのパラメーターを変更します。

操作説明

  • ApsaraDB for MongoDB インスタンスは、実行中の状態である必要があります。

  • 再起動が必要なパラメーターを変更すると、インスタンスは自動的に再起動します。再起動が必要なパラメーターを確認するには、DescribeParameterTemplates 操作を呼び出します。

今すぐお試しください

この 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:ModifyParameters

update

*Instance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

インスタンスのリージョン ID。最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出します。

cn-hangzhou

DBInstanceId

string

必須

インスタンス ID。

説明

このパラメーターがシャードクラスターインスタンス ID の場合は、NodeId パラメーターも指定する必要があります。

dds-bp19f409d75****

NodeId

string

任意

シャードクラスターインスタンス内の Mongos またはシャードノードの ID。

説明

このパラメーターは、DBInstanceId パラメーターがシャードクラスターインスタンス ID に設定されている場合にのみアクティブになります。

d-bp1b7bb3bbe****

Parameters

string

必須

パラメーターとその新しい値。値は JSON 文字列である必要があります。例: {"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}。

説明

DescribeParameterTemplates 操作を呼び出して、デフォルトのパラメーターテンプレートのリストを照会します。

{"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"}

CharacterType

string

任意

ノードのタイプ。有効な値:

  • db: シャードノード。

  • cs: ConfigServer ノード。

  • mongos: Mongos ノード。

db

SwitchMode

string

任意

パラメーターの変更を適用する時間。有効な値:

  • 0: すぐに。

  • 1: メンテナンスウィンドウ中。

列挙値:

  • 0 :

    0

  • 1 :

    1

0

レスポンスフィールド

フィールド

説明

object

応答。

RequestId

string

リクエスト ID。

36923CC2-DDAB-4B48-A144-DA92C1E19537

成功レスポンス

JSONJSON

{
  "RequestId": "36923CC2-DDAB-4B48-A144-DA92C1E19537"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameters.Format Specified parameters is not valid.
400 InvalidParameterForInstanceVersion Parameter %s is not valid for instance's MinorVersion.
400 InvalidParameter The specified parameter %s is not valid.
400 OplogSizeLowerThanInstanceStorage The oplogSizeMB parameter entered is less than 10% of the instance store size.

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

変更履歴

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