1 つの新しいファイル システム ストアを構成します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/fileSystemConfigsリクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
Body Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
割り当てEnabled | ブール値 | 任意 | このファイルシステム ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
id | string | 必須 | このファイル システム ストアの一意の識別子。 |
labels | 文字列の配列 | 任意 | MongoDB Ops Manager がどの ファイルシステム ストア に割り当てることができる バックアップジョブ を管理するためのタグ。 これらのタグを設定すると、このファイルシステム ストアが処理できるバックアップジョブが制限されます。 省略した場合、このファイルシステム ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。 |
loadFactory | 数値 | 任意 | このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 複数のスナップショットストアを使用している場合にのみ、このオプションを設定します。 Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。 |
mmapv1CompressionSetting | string | 必須 | スナップショットにMMAPv1ストレージエンジンを使用する場合の圧縮設定。 MongoDB Ops Manager は MongoDB がFCV 4.2以降を実行している場合、MongoDB Atlas はこの設定を無視します。 重要: MongoDB は、6.0 より前のバージョンのMongoDBで MMAPv1ストレージエンジンのサポートを削除しました。配置の構成を編集してストレージエンジンをWiredTigerストレージ エンジンに変更すると、 MongoDB Ops Manager はMongoDBプロセスを再起動します。 |
StorePath | string | 必須 | ファイル システム ベースのバックアップがファイル システム ストア ホストに保存されるロケーション。 |
wtCompressionSetting | string | 必須 | スナップショットにWiredTigerストレージエンジンを使用する場合の圧縮設定。 MongoDB Ops Manager は MongoDB がFCV 4.2以降を実行している場合、MongoDB Atlas はこの設定を無視します。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
割り当てEnabled | ブール値 | このファイルシステム ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
id | string | このファイル システム ストアの一意の識別子。 |
labels | 文字列の配列 | MongoDB Ops Manager がどの ファイル システム ストア に割り当てることができる バックアップ ジョブ を管理するタグ。 |
Links | オブジェクトの配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
loadFactory | 数値 | このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 複数のスナップショットストアを使用している場合にのみ、このオプションを設定します。 Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。 |
mmapv1CompressionSetting | string | スナップショットに MMAPv1 storage engine を使用する場合の圧縮設定。 MongoDB Ops Manager は MongoDBがFCV 4.2 以降を実行している場合、 MongoDB Ops Managerはこの設定を無視します。 重要: MongoDB は、6.0 より前のバージョンのMongoDBで MMAPv1ストレージエンジンのサポートを削除しました。配置の構成を編集してストレージエンジンをWiredTigerストレージ エンジンに変更すると、 MongoDB Ops Manager はMongoDBプロセスを再起動します。 |
StorePath | string | ファイル システム ストア ホストに保存されるファイル システム ベースのバックアップが保存される、システム ルート相対ディレクトリ パス。 |
wtCompressionSetting | string | スナップショットに WiredTiger ストレージ エンジン を使用する場合の圧縮設定。 MongoDB Ops Manager は MongoDBがFCV 4.2 以降を実行している場合、 MongoDB Ops Managerはこの設定を無視します。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true' \ --data '{ "assignmentEnabled" : true, "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}", "labels" : [ "l1", "l2" ], "loadFactor" : 50, "mmapv1CompressionSetting" : "NONE", "storePath" : "/data/backup", "wtCompressionSetting" : "GZIP" }'応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "assignmentEnabled" : true, "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs", "rel" : "self" }], "loadFactor" : 50, "mmapv1CompressionSetting" : "NONE", "storePath" : "/data/backup", "wtCompressionSetting" : "GZIP"}