すべてのバックアップデーモン構成を取得する
項目一覧
MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。 可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。
すべてのバックアップデーモンの構成を取得します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /daemon/configs
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
results | 配列 | 配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのバックアップデーモンです。
名前 | タイプ | 説明 |
|---|---|---|
assignmentEnabled | ブール値 | このバックアップデーモンにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
backupJobsEnabled | ブール値 | このバックアップデーモンがデータベースのバックアップに使用できるかどうかを示すフラグ。 |
configured | ブール値 | このバックアップデーモンが使用可能かどうかを示すフラグ。 |
garbageCollectionEnabled | ブール値 | このバックアップデーモンにガベージ コレクションが設定されているかどうかを示すフラグ。 |
headDiskType | string | |
id | string | |
labels | 文字列の配列 | がどの MongoDB Ops Managerバックアップデーモン に割り当てることができる バックアップジョブ を管理するためのタグの配列。 |
links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
machine | オブジェクト | バックアップデーモンのホストとそのヘッドディレクトリ。 |
machine.headRootDirectory | string | この バックアップデーモン ホスト上の ヘッドディレクトリ のルート相対パス。 |
machine.machine | string | バックアップデーモンホストのホスト名または IP アドレス。 |
numWorkers | 数値 | タスクを実行できるワーカープロセスの数（つまり、 バックアップ、復元、またはグルーム）を作成します。 |
resourceUsageEnabled | ブール値 | このバックアップデーモンのリソース使用量が監視されているかどうかを示すフラグ。 |
restoreQueryableJobsEnabled | ブール値 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?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}
レスポンス本体
{ "links" : [ { "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled" : true, "backupJobsEnabled" : false, "configured" : true, "garbageCollectionEnabled" : true, "headDiskType" : "SSD", "id" : "{DAEMON-CONFIG}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{DAEMON-CONFIG}", "rel" : "self" }], "machine" : { "headRootDirectory" : "/data/backup/", "machine" : "localhost" }, "numWorkers" : 50, "resourceUsageEnabled" : true, "restoreJobsEnabled" : false, "restoreQueryableJobsEnabled" : true } ], "totalCount" : 1 }