Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
バックアップ管理
/
ファイルシステムストアの構成

1 つのファイルシステム ストア構成を作成

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

1 つの新しいファイル システム ストアを構成します。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

POST /snapshot/fileSystemConfigs

リクエスト パス パラメーター

このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false

リクエスト ボディ パラメータ

Body Parameter
タイプ
必要性
説明
割り当てEnabled
ブール値
任意
このファイルシステム ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
id
string
必須
このファイル システム ストアの一意の識別子。
labels
文字列の配列
任意

がどの MongoDB Ops Managerファイル システム ストア に割り当てることができる バックアップ ジョブ を管理するためのタグ。

これらのタグを設定すると、このファイルシステム ストアが処理できるバックアップジョブが制限されます。 省略した場合、このファイルシステム ストアは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。

loadFactory
数値
任意

このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 複数のスナップショットストアを使用している場合にのみ、このオプションを設定します。

Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。

mmapv1CompressionSetting
string
条件付き

スナップショットに MMAPv1 storage engine を使用する場合の圧縮設定。

MongoDB Ops Manager はNONEまたはGZIPを受け入れます。

MongoDB がFCV 4.2以降を実行している場合、MongoDB Atlas はこの設定を無視します。

重要: MongoDBはMongoDB 4.2で MMAPv 1ストレージエンジンのサポートを削除しました。 配置の構成を編集してストレージエンジンをWiredTigerストレージエンジン に変更すると、 MongoDB Ops ManagerはMongoDBプロセスを再起動します。

StorePath
string
必須
ファイル システム ベースのバックアップがファイル システム ストア ホストに保存されるロケーション。
wtCompressionSetting
string
条件付き

スナップショットに WiredTiger ストレージ エンジン を使用する場合の圧縮設定。

MongoDB Ops Manager はNONEまたはGZIPを受け入れます。

MongoDB がFCV 4.2以降を実行している場合、MongoDB Atlas はこの設定を無視します。

応答

名前
タイプ
説明
割り当てEnabled
ブール値
このファイルシステム ストアにバックアップジョブを割り当てることができるかどうかを示すフラグ。
id
string
このファイル システム ストアの一意の識別子。
labels
文字列の配列
Links
オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

loadFactory
数値

このスナップショットストアが別のスナップショットストアと比較して実行するバックアップ作業量を表すゼロ以外の正の整数。 複数のスナップショットストアを使用している場合にのみ、このオプションを設定します。

Load Factorの詳細については、 「 1 つの既存のブロックストアの編集 」を参照してください。

mmapv1CompressionSetting
string

スナップショットに MMAPv1 storage engine を使用する場合の圧縮設定。

MongoDB Ops Manager はNONEまたはGZIPを返す場合があります。

MongoDBがFCV 4.2 以降を実行している場合、 MongoDB Ops Managerはこの設定を無視します。

重要: MongoDBはMongoDB 4.2で MMAPv 1ストレージエンジンのサポートを削除しました。 配置の構成を編集してストレージエンジンをWiredTigerストレージエンジン に変更すると、 MongoDB Ops ManagerはMongoDBプロセスを再起動します。

StorePath
string
ファイル システム ストア ホストに保存されるファイル システム ベースのバックアップが保存される、システム ルート相対ディレクトリ パス。
wtCompressionSetting
string

スナップショットに WiredTiger ストレージ エンジン を使用する場合の圧縮設定。

MongoDB Ops Manager はNONEまたはGZIPを返す場合があります。

MongoDBがFCV 4.2 以降を実行している場合、 MongoDB Ops Managerはこの設定を無視します。

リクエストの例

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2     --header 'Accept: application/json' \
3     --header 'Content-Type: application/json' \
4     --include \
5     --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true' \
6     --data '{
7       "assignmentEnabled" : true,
8       "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9       "labels" : [ "l1", "l2" ],
10       "loadFactor" : 50,
11       "mmapv1CompressionSetting" : "NONE",
12       "storePath" : "/data/backup",
13       "wtCompressionSetting" : "GZIP"
14     }'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

1{
2  "assignmentEnabled" : true,
3  "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
4  "labels" : [ "l1", "l2" ],
5  "links" : [ {
6    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs",
7    "rel" : "self"
8  }],
9  "loadFactor" : 50,
10  "mmapv1CompressionSetting" : "NONE",
11  "storePath" : "/data/backup",
12  "wtCompressionSetting" : "GZIP"
13}

戻る

すべてのファイルシステム ストア構成を取得する

次へ

1 つのファイルシステム ストア構成の更新