ID を使用して 1 つのファイルシステム ストア構成を取得
1 つのファイル システム ストアの構成を取得します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}
リクエスト パス パラメーター
Path Parameter | タイプ | 必要性 | 説明 |
---|---|---|---|
ファイル-SYSTEM-Config-ID | string | 必須 | このファイルシステム ストア構成にラベルを付ける一意の名前。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
---|---|---|
割り当て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はMongoDB 4.2で MMAPv 1ストレージエンジンのサポートを削除しました。 配置の構成を編集してストレージエンジンを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' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}?pretty=true'
応答例
応答ヘッダー
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
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/{FILE-SYSTEM-CONFIG-ID}", 7 "rel" : "self" 8 }], 9 "loadFactor" : 50, 10 "mmapv1CompressionSetting" : "NONE", 11 "storePath" : "/data/backup", 12 "wtCompressionSetting" : "GZIP" 13 }