指定されたプロジェクト内の 1 つのクラスターの高度な構成の詳細を更新します。クラスターには、同じデータセットを維持するホストのグループが含まれます。高度な設定の詳細には、読み取り書込み保証 (write concern)、インデックスおよびoplog制限、およびその他のデータベース設定が含まれます。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーに プロジェクト クラスター マネージャー ロールが必要です。この機能は、M0 の無料クラスター、M2 と M5 の共有階層クラスター、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
クラスターを識別する人間が判読できるラベル。
形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。
アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。
デフォルト値はfalseです。
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値はfalseです。
指定されたプロジェクト内の 1 つのクラスターに追加する高度な構成の詳細。
変更前と変更後のイメージの最小保持時間(秒単位)。
デフォルト値は-1です。
チャンク移行のソース シャードおよび受信シャード上のスレッドの数。スレッドの数は、シャーディングされたクラスター内の CPU コアの合計数の半分を超えてはなりません。
TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、tlsCipherConfigMode が CUSTOM に設定されている場合にのみ有効です。
値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。
個々の読み取り操作完了のためのデフォルトの時間制限(ミリ秒単位)。
このクラスターに設定された読み取り操作に対して、MongoDB から要求される確認応答のデフォルト レベル。
MongoDB 4.4 クラスターのデフォルトは available です。MongoDB 5.0 以降のクラスターのデフォルトは local です。
値は local または available です。デフォルト値は available です。
ドライバーによって何も指定されていない場合に、書込み (write) 操作に対して MongoDB が要求する確認応答のデフォルト レベル。
すべてのインデックスエントリが 1024 バイトを超えないドキュメントを挿入または更新できるかどうかを示すフラグ。これが false に設定されている場合、mongod はこの制限を超えるドキュメントを書込みますが、インデックスしません。MongoDB 4.4 以降、このパラメータは削除されました。
デフォルト値はtrueです。
クラスターが JavaScript のサーバー側実行を行う操作の許可の是非を示すフラグ。8.0+ を使用する場合、よりパフォーマンスの高い代替手段として、サーバーサイドの JavaScript を無効にし、集約パイプラインの演算子を使用することをお勧めします。
クラスターが受信接続に受け入れる TLS(Transport Layer Security)の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。
値は TLS1_0、TLS1_1、または TLS1_2 です。
結果を返すためにコレクションスキャンが必要なクエリについて、クラスターで実行が無効化されているかどうかを示すフラグ。
クラスターの oplog の最小保持ウィンドウ(単位は時間)。null 値の場合、MongoDB Cloud が計算するデフォルトの最小 oplog window をクラスターが使用することを示します。
クラスターの oplog のストレージ制限(単位はメガバイト)。null 値の場合、MongoDB Cloud が計算するデフォルトの oplog サイズをクラスターが使用することを示します。
1(無効)または 3(有効)に設定できます。3 に設定されている場合、Atlas は編集され、匿名化された $queryStats 出力を MongoDB ログに含めます。$queryStats 出力にはリテラル値またはフィールド値は含まれません。この設定を有効にすると、クラスターのパフォーマンスに影響を与える可能性があります。
mongosqld プロセスがデータを再サンプリングしてリレーショナル スキーマを作成する間隔(単位は秒)。
の最小値は 0 です。デフォルト値は 0 です。
スキーマ情報を収集するときにサンプリングするデータベースあたりのドキュメントの数。
の最小値は 0 です。
TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。
値は CUSTOM または DEFAULT です。
マルチドキュメントトランザクションの有効期間(単位は秒)。Atlas は、この制限を超えるトランザクションは期限切れと見なし、定期的なクリーンアップ プロセスによって中断します。
の最小値は 1 です。
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/processArgs' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"changeStreamOptionsPreAndPostImagesExpireAfterSeconds":-1,"chunkMigrationConcurrency":42,"customOpensslCipherConfigTls12":["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"],"defaultMaxTimeMS":42,"defaultReadConcern":"available","defaultWriteConcern":"string","failIndexKeyTooLong":true,"javascriptEnabled":true,"minimumEnabledTlsProtocol":"TLS1_0","noTableScan":true,"oplogMinRetentionHours":42.0,"oplogSizeMB":42,"queryStatsLogVerbosity":42,"sampleRefreshIntervalBIConnector":0,"sampleSizeBIConnector":42,"tlsCipherConfigMode":"CUSTOM","transactionLifetimeLimitSeconds":42}'
{
"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 42,
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 42,
"defaultReadConcern": "available",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 42.0,
"oplogSizeMB": 42,
"queryStatsLogVerbosity": 42,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 42,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 42
}
{
"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 42,
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 42,
"defaultReadConcern": "available",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 42.0,
"oplogSizeMB": 42,
"queryStatsLogVerbosity": 42,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 42,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 42
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}