1 つのバックアップデーモン構成の更新

項目一覧

Resource

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

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

1 つのバックアップデーモンの構成を更新します。

注意

すでに構成したバックアップデーモンを 1 つ更新する場合は、このエンドポイントを使用します。

バックアップデーモンをまだ構成していない場合は、 1 つのバックアップデーモン構成の作成エンドポイントを使用して構成します。

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

Resource

PUT /daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}

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

名前

タイプ

必要性

説明

マシン

string

必須

バックアップデーモンを提供するマシンのホスト名または IP アドレス。

ヘッドルートディレクトリ

string

必須

ルート相対の URL エンコードパスこのバックアップデーモンホスト上のヘッドディレクトリの

リクエストでは、URL パスでスラッシュをエンコードする。たとえば、Linux プラットフォームの場合は、次の形式でヘッドディレクトリを追加する必要があります。

http://localhost:8080/api/public/v1.0/admin/backup/
daemon/config/localhost/%2Fdata%2Fbackup%2F

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

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ形式。

false

envelope

ブール値

任意

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

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

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

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

false

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

名前	タイプ	必要性	説明
`assignmentEnabled`	ブール値	任意	このバックアップデーモンにバックアップジョブを割り当てることができるかどうかを示すフラグ。
`backupJobsEnabled`	ブール値	任意	このバックアップデーモンがデータベースのバックアップに使用できるかどうかを示すフラグ。
`configured`	ブール値	任意	このバックアップデーモンが使用可能かどうかを示すフラグ。
`garbageCollectionEnabled`	ブール値	任意	このバックアップデーモンにガベージコレクションが設定されているかどうかを示すフラグ。
`headDiskType`	string	任意	ヘッドディレクトリを保存するために使用されるディスクのタイプ。このオプションに指定できる値は以下のとおりです。 `HDD` `SSD`
`id`	string	必須	このバックアップデーモンの一意の識別子。
`labels`	文字列の配列	任意	がどの MongoDB Ops Managerバックアップデーモンに割り当てることができるバックアップジョブを管理するためのタグの配列。これらのタグを設定すると、このバックアップデーモンが処理できるバックアップジョブが制限されます。省略した場合、このバックアップデーモンは、ジョブをフィルタリングするためにラベルを使用しないプロジェクトのバックアップジョブのみを処理できます。
`machine`	オブジェクト	必須	バックアップデーモンのホストとそのヘッドディレクトリ。
`machine.headRootDirectory`	string	任意	このバックアップデーモンホスト上のヘッドディレクトリのルート相対パス。このディレクトリは、スラッシュ（ `/` ）で終わる必要があります。スラッシュを省略すると、バックアップデーモンは Java 例外エラーを生成します。
`machine.machine`	string	必須	バックアップデーモンホストのホスト名または IP アドレス。
`numWorkers`	数値	任意	タスクを実行できるワーカープロセスの数（つまり、バックアップ、復元、またはグルーム）を作成します。
`resourceUsageEnabled`	ブール値	任意	このバックアップデーモンのリソース使用量が監視されているかどうかを示すフラグ。
`restoreQueryableJobsEnabled`	ブール値	任意	このバックアップデーモンがクエリ可能な復元を実行できるかどうかを示すフラグ。

応答

名前	タイプ	説明
`assignmentEnabled`	ブール値	このバックアップデーモンにバックアップジョブを割り当てることができるかどうかを示すフラグ。
`backupJobsEnabled`	ブール値	このバックアップデーモンがデータベースのバックアップに使用できるかどうかを示すフラグ。
`configured`	ブール値	このバックアップデーモンが使用可能かどうかを示すフラグ。
`garbageCollectionEnabled`	ブール値	このバックアップデーモンにガベージコレクションが設定されているかどうかを示すフラグ。
`headDiskType`	string	ヘッドディレクトリを保存するために使用されるディスクのタイプ。このオプションに指定できる値は以下のとおりです。 `HDD` `SSD`
`id`	string	このバックアップデーモンの一意の識別子。
`labels`	文字列の配列	がどの MongoDB Ops Managerバックアップデーモンに割り当てることができるバックアップジョブを管理するためのタグの配列。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`machine`	オブジェクト	バックアップデーモンのホストとそのヘッドディレクトリ。
`machine.headRootDirectory`	string	このバックアップデーモンホスト上のヘッドディレクトリのルート相対パス。
`machine.machine`	string	バックアップデーモンホストのホスト名または IP アドレス。
`numWorkers`	数値	タスクを実行できるワーカープロセスの数（つまり、バックアップ、復元、またはグルーム）を作成します。
`resourceUsageEnabled`	ブール値	このバックアップデーモンのリソース使用量が監視されているかどうかを示すフラグ。
`restoreQueryableJobsEnabled`	ブール値	このバックアップデーモンがクエリ可能な復元を実行できるかどうかを示すフラグ。

リクエストの例

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "backupJobsEnabled" : false,
9        "configured" : true,
10        "garbageCollectionEnabled" : true,
11        "headDiskType" : "SSD",
12        "labels" : [ "l1", "l2" ],
13        "machine" : {
14          "headRootDirectory" : "/data/backup/",
15          "machine" : "localhost"
16        },
17        "numWorkers" : 50,
18        "resourceUsageEnabled" : true,
19        "restoreQueryableJobsEnabled" : true
20      }'

応答例

応答ヘッダー

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   "backupJobsEnabled" : false,
4   "configured" : true,
5   "garbageCollectionEnabled" : true,
6   "headDiskType" : "SSD",
7   "id" : "5991a422ad5df350005dd062",
8   "labels" : [ "l1", "l2" ],
9   "links" : [ {
10     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}",
11     "rel" : "self"
12   }],
13   "machine" : {
14     "headRootDirectory" : "/data/backup/",
15     "machine" : "localhost"
16   },
17   "numWorkers" : 50,
18   "resourceUsageEnabled" : true,
19   "restoreQueryableJobsEnabled" : true
20 }

戻る

1 つのバックアップデーモン構成を作成

1 つのバックアップデーモン構成を削除

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"backupJobsEnabled" : false,
9	"configured" : true,
10	"garbageCollectionEnabled" : true,
11	"headDiskType" : "SSD",
12	"labels" : [ "l1", "l2" ],
13	"machine" : {
14	"headRootDirectory" : "/data/backup/",
15	"machine" : "localhost"
16	},
17	"numWorkers" : 50,
18	"resourceUsageEnabled" : true,
19	"restoreQueryableJobsEnabled" : true
20	}'

注意