注意
バックアップデーモンを初めて構成するときに、このエンドポイントを使用します。 このエンドポイントを使用してバックアップデーモン プロセスが実行されていることを確認する前に、バックアップデーモン プロセスが実行されていることを確認してください。
バックアップデーモンをすでに構成している場合は、「 1 つのバックアップデーモン構成の更新 」エンドポイントを使用して更新します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
PUT /daemon/configs/{MACHINE}リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
マシン | string | 必須 | バックアップデーモンを提供するマシンのホスト名または IP アドレス。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| ブール値 | 任意 | このバックアップデーモンにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
| ブール値 | 任意 | このバックアップデーモンがデータベースのバックアップに使用できるかどうかを示すフラグ。 |
| ブール値 | 任意 | このバックアップデーモンが使用可能かどうかを示すフラグ。 |
| ブール値 | 任意 | このバックアップデーモンにガベージ コレクションが設定されているかどうかを示すフラグ。 |
| string | 任意 | |
| 文字列の配列 | 任意 | がどの MongoDB Ops Managerバックアップデーモン に割り当てることができる バックアップジョブ を管理するためのタグの配列。 これらのタグを設定すると、このバックアップデーモンが処理できるバックアップジョブが制限されます。 省略した場合、このバックアップデーモンは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。 |
| オブジェクト | 必須 | バックアップデーモンのホストとそのヘッドディレクトリ。 |
| string | 任意 | この バックアップデーモン ホスト上の ヘッドディレクトリ のルート相対パス。このディレクトリは、スラッシュ（ |
| string | 必須 | バックアップデーモンホストのホスト名または IP アドレス。 |
| 数値 | 任意 | タスクを実行できるワーカープロセスの数（つまり、 バックアップ、復元、またはグルーム）を作成します。 |
| ブール値 | 任意 | このバックアップデーモンのリソース使用量が監視されているかどうかを示すフラグ。 |
| ブール値 | 任意 |
応答
名前 | タイプ | 説明 |
|---|---|---|
| ブール値 | このバックアップデーモンにバックアップジョブを割り当てることができるかどうかを示すフラグ。 |
| ブール値 | このバックアップデーモンがデータベースのバックアップに使用できるかどうかを示すフラグ。 |
| ブール値 | このバックアップデーモンが使用可能かどうかを示すフラグ。 |
| ブール値 | このバックアップデーモンにガベージ コレクションが設定されているかどうかを示すフラグ。 |
| string | |
| string | |
| 文字列の配列 | がどの MongoDB Ops Managerバックアップデーモン に割り当てることができる バックアップジョブ を管理するためのタグの配列。 |
| オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
| オブジェクト | バックアップデーモンのホストとそのヘッドディレクトリ。 |
| string | この バックアップデーモン ホスト上の ヘッドディレクトリ のルート相対パス。 |
| string | バックアップデーモンホストのホスト名または IP アドレス。 |
| 数値 | タスクを実行できるワーカープロセスの数（つまり、 バックアップ、復元、またはグルーム）を作成します。 |
| ブール値 | このバックアップデーモンのリソース使用量が監視されているかどうかを示すフラグ。 |
| ブール値 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/?pretty=true' \ --data '{ "assignmentEnabled" : true, "backupJobsEnabled" : false, "configured" : true, "garbageCollectionEnabled" : true, "headDiskType" : "SSD", "labels" : [ "l1", "l2" ], "machine" : { "headRootDirectory" : "/data/backup/", "machine" : "localhost" }, "numWorkers" : 50, "resourceUsageEnabled" : true, "restoreQueryableJobsEnabled" : true }'応答例
応答ヘッダー
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, "backupJobsEnabled" : false, "configured" : true, "garbageCollectionEnabled" : true, "headDiskType" : "SSD", "id" : "{BACKUP-DAEMON-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/<machine.headRootDirectory>", "rel" : "self" }], "machine" : { "headRootDirectory" : "/data/backup/", "machine" : "localhost" }, "numWorkers" : 50, "resourceUsageEnabled" : true, "restoreQueryableJobsEnabled" : true}