AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つのプロジェクトバックアップジョブ構成の更新

1 件のプロジェクトのバックアップジョブの構成を更新します。

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

Resource

PUT /groups/{PROJECT-ID}

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

名前
タイプ
説明

プロジェクトID

string

このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

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

名前
タイプ
説明

damonFilter

オブジェクト配列

任意。 このプロジェクトのバックアップジョブが制限されるバックアップデーモンのホストとそのヘッドディレクトリのペアの配列。 省略した場合は、使用可能なすべてのバックアップデーモンが使用されます。

damonFilter.headRootDirectory

string

デーモンフィルター.マシン

string

1 つのバックアップデーモンホストのホスト アドレス。

id

string

このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。

kmipClientCertPassword

string

Optional. The password that encrypts the KMIP client certificate.

kmipClientCertPath

string

任意。バックアップデーモン ホスト上の、KMIP クライアント証明書を保存するルート相対パス。

labelsFilter

文字列の配列

任意。 このプロジェクトの バックアップジョブ を処理できる バックアップデーモン と スナップショット ストア を制限するタグの配列。

スナップショットストアまたはバックアップデーモンの で、このlabelFilterと同じlabelsが設定されている場合は、このプロジェクトのバックアップジョブを処理できます。

省略した場合、プロジェクトのバックアップジョブでは、利用可能な任意のバックアップデーモンまたはスナップショット ストアを使用できます。

oplogStoreFilter

オブジェクトの配列

任意。 このプロジェクトのバックアップジョブで使用される可能性のあるoplogストアを表す一意の識別子の配列。 省略した場合、利用可能なすべての oplog ストアを使用できます。

oplogStoreFilter.id

string

このプロジェクトのバックアップジョブで使用可能なoplog ストアを表す一意の識別子。

id「すべてのoplog oplog構成を取得 する」で使用する ストアの を取得します。

oplogStoreFilter.type

string

使用するoplogストアのタイプ。

指定できる値は以下のとおりです。

  • oplogStore

  • s3OplogStore

  • thirdPartyOplogStore

snapshotStoreFilter

オブジェクトの配列

任意。 このプロジェクトのバックアップジョブで使用できる特定のスナップショット ストアとそのタイプを表す一意な識別子の配列。 省略すると、使用可能なすべてのスナップショット ストアが使用されます。

snapshotStoreFilter.id

string

任意。 このプロジェクトのバックアップジョブで使用できる特定のスナップショット ストアを表す一意の識別子。

snapshotStoreFilter.type

string

任意。 snapshotStoreFilter.idと指定された特定のスナップショット保存のタイプ。

このオプションに指定できる値は以下のとおりです。

  • s3blockstore

  • blockstore

  • fileSystemStore

syncStoreFilter

文字列の配列

任意。 このプロジェクトのバックアップジョブで使用できる同期ストア フィルターの配列。 省略すると、利用可能なすべての同期ストアが使用されます。

応答

名前
タイプ
説明

damonFilter

オブジェクト配列

このプロジェクトのバックアップジョブが制限されるバックアップデーモンのホストとそのヘッドディレクトリのペアの配列。

damonFilter.headRootDirectory

string

デーモンフィルター.マシン

string

1 つのバックアップデーモンホストのホスト アドレス。

id

string

このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。

kmipClientCertPassword

string

KMIPクライアント証明書を暗号化するパスワード。

kmipClientCertPath

string

Links

オブジェクト配列

サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての links 配列には、self と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

labelsFilter

文字列の配列

このプロジェクトの バックアップジョブ を処理できる バックアップデーモン と スナップショット ストア を制限するタグの配列。

oplogStoreFilter

オブジェクトの配列

このプロジェクトのバックアップジョブで使用される可能性のあるoplogストアを表す一意の識別子の配列。

oplogStoreFilter.id

string

このプロジェクトのバックアップジョブで使用可能なoplog ストアを表す一意の識別子。

oplogStoreFilter.type

string

使用するoplogストアのタイプ。

指定できる値は以下のとおりです。

  • oplogStore

  • s3OplogStore

  • thirdPartyOplogStore

snapshotStoreFilter

オブジェクトの配列

このプロジェクトのバックアップジョブで使用できる特定のスナップショット ストアとそのタイプを表す一意な識別子の配列。 省略すると、使用可能なすべてのスナップショット ストアが使用されます。

snapshotStoreFilter.id

string

このプロジェクトのバックアップジョブで使用できる特定のスナップショット ストアを表す一意の識別子。

snapshotStoreFilter.type

string

snapshotStoreFilter.idと指定された特定のスナップショット保存のタイプ。

このオプションに指定できる値は以下のとおりです。

  • s3blockstore

  • blockstore

  • fileSystemStore

syncStoreFilter

文字列の配列

このプロジェクトのバックアップジョブで使用できる同期ストア フィルターの配列。 省略すると、利用可能なすべての同期ストアが使用されます。

リクエストの例

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/groups/{PROJECT-ID}?pretty=true' \ --data '{  "daemonFilter" : [ {     "headRootDirectory" : "/data/backup",     "machine" : "http://backup.example.com"   } ],   "id" : "{PROJECT-ID}",   "kmipClientCertPassword" : "P4$$w0rD",   "kmipClientCertPath" : "/certs/kmip",   "labelFilter" : [ "label1", "label2" ],   "oplogStoreFilter" : [ {     "id" : "oplog1",     "type" : "oplogStore"   } ],   "snapshotStoreFilter" : [ {     "id" : "sPid",     "type" : "s3blockstore"   } ],   "syncStoreFilter" : [ "s1", "s2" ] }'

応答例

応答ヘッダー

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-alive
HTTP/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}

レスポンス本体

{  "daemonFilter" : [ {    "headRootDirectory" : "/data/backup",    "machine" : "http://backup.example.com"  } ],  "id" : "{PROJECT-ID}",  "kmipClientCertPassword" : "P4$$w0rD",  "kmipClientCertPath" : "/certs/kmip",  "labelFilter" : [ "label1", "label2" ],  "links" : [ {    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}",    "rel" : "self"  }, {    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}",    "rel" : "http://mms.mongodb.com/group"  } ],  "oplogStoreFilter" : [ {    "id" : "oplog1",    "type" : "oplogStore"  } ],  "snapshotStoreFilter" : [ {    "id" : "sPid",    "type" : "s3blockstore"  } ],  "syncStoreFilter" : [ "s1", "s2" ]}
戻る
すべて取得
次へ
バックアップ暗号化キー
このページを評価

項目一覧