すべてのファイルシステム ストア構成を取得する
項目一覧
すべてのファイル システム ストアの構成を取得します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /snapshot/fileSystemConfigs
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
assignableOnly | ブール値 | 任意 | このファイルシステム ストアに新しいバックアップジョブを割り当てることができるかどうかを示すフラグ。 | true |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
results | 配列 | 配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのファイルシステム ストアです。
名前 | タイプ | 説明 |
|---|---|---|
割り当て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?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 "links" : [ { 3 "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "assignmentEnabled" : true, 8 "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}", 9 "labels" : [ "l1", "l2" ], 10 "links" : [ { 11 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILESYSTEM-ID}", 12 "rel" : "self" 13 }], 14 "loadFactor" : 50, 15 "mmapv1CompressionSetting" : "NONE", 16 "storePath" : "/data/backup", 17 "wtCompressionSetting" : "GZIP" 18 } ], 19 "totalCount" : 1 20 }