Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

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

項目一覧

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

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

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

PUT /groups/{PROJECT-ID}
名前
タイプ
説明
プロジェクトID
string
このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false
名前
タイプ
説明
damonFilter
オブジェクト配列
任意。 このプロジェクトのバックアップジョブが制限されるバックアップデーモンのホストとそのヘッドディレクトリのペアの配列。 省略した場合は、使用可能なすべてのバックアップデーモンが使用されます。
damonFilter.headRootDirectory
string
デーモンフィルター.マシン
string
1 つのバックアップデーモンホストのホスト アドレス。
id
string
このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。
kmipClientCertPassword
string
任意。 KMIPクライアント証明書を暗号化するパスワード。
kmipClientCertPath
string
任意。 KMIP クライアント証明書を保存する バックアップデーモン ホスト上のルート相対パス。
labelsFilter
文字列の配列

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

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

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

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

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

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

oplogStoreFilter.type
string
使用するoplog ストアのタイプ。 サポートされている値はoplogStoreのみです。
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です。
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 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}
{
"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" ]
}

戻る

すべてのプロジェクトバックアップジョブ構成を取得する