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

項目一覧

Resource

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

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

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

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

Resource

GET /groups

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

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

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

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのプロジェクトのバックアップジョブです。

名前	タイプ	説明
damonFilter	オブジェクト配列	このプロジェクトのバックアップジョブが制限されるバックアップデーモンのホストとそのヘッドディレクトリのペアの配列。
damonFilter.headRootDirectory	string	このバックアップデーモンホスト上のヘッドディレクトリのルート相対パス。
デーモンフィルター.マシン	string	1 つのバックアップデーモンホストのホストアドレス。
id	string	このプロジェクトとそのバックアップジョブ構成を表す一意の識別子。
kmipClientCertPassword	string	KMIPクライアント証明書を暗号化するパスワード。
kmipClientCertPath	string	KMIP クライアント証明書を保存するバックアップデーモンホスト上のディレクトリへのパスです。
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' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true'

応答例

応答ヘッダー

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}

レスポンス本体

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "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" ]
  } ],
  "totalCount" : 1
}

戻る

ID を使用して 1 つのプロジェクトバックアップジョブ構成を取得

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

Resource

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

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

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

応答