1 つのクラスターのすべてのスナップショットを取得

項目一覧

Resource

Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例

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

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

Resource

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots

Request Parameters

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

名前	タイプ	説明
プロジェクトID	string	スナップショットを所有するプロジェクトの一意の識別子。
CLUSTER-ID	string	スナップショットが表すクラスターの一意の識別子。

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

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

名前	タイプ	必要性	説明	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 つの同期ストアです。

`Name`	タイプ	説明
`clusterId`	string	スナップショットが表すクラスターの一意の識別子。
`complete`	ブール値	スナップショットが作成されたことを示すフラグ。スナップショット作成ジョブがまだ進行中の場合、これは`false`です。
`created`	ドキュメント	タイムスタンプのコンポーネント。
`created` `.date`	タイムスタンプ	スナップショットが作成されたときの iso 8601 -time。
`created` `.increment`	integer	このスナップショットが正確な時点で実行された操作順序。 MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ」を参照してください。
`doNotDelete`	ブール値	スナップショットが削除できないことを示すフラグ。
`expires`	タイムスタンプ	ISO8601 のタイムスタンプこのスナップショットを削除できる UTC の UTC の日付と時刻形式。 `doNotDelete`が`true`に設定されている場合、 `expires`のすべての値が削除されます。 `expires`値が現在の日時より前の場合、編集することはできません。
`groupId`	string	スナップショットを所有するプロジェクトの一意の識別子。
`id`	string	スナップショットの一意の識別子。
`isPossibly` `Inconsistent`	ブール値	このスナップショットの整合性を示すフラグ。 `isPossiblyInconsistent`はシャーディングされたクラスターのスナップショットにのみ表示されます。一貫性のある状態でシャーディングされたクラスターのスナップショットを作成するには、スナップショットを作成する前に、バックアップは一時的にバランサーをオフにします。場合によっては、バランサーを一定時間でオフにできない場合があります。次に、バランサーが実行中の状態でスナップショットが作成されます。こうした場合、スナップショットは一貫性のない状態になる可能性があります（たとえば、チャンクの移行が進行中である場合など）。
`lastOplog` `AppliedTimestamp`	ドキュメント	最後の oplog エントリのタイムスタンプのコンポーネントが適用されました。
`lastOplog` `AppliedTimestamp` `.date`	タイムスタンプ	ISO8601 のタイムスタンプ最後の oplog が適用されたとき、 UTC の日付と時刻形式（ UTC ）。
`lastOplog` `AppliedTimestamp` `.increment`	integer	Operation order in which last oplog was applied at this exact point in time. MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ」を参照してください。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`namespaceFilterList`	オブジェクト	このスナップショットに含まれる名前空間または除外される名前空間。
`namespaceFilterList` `.filterList`	string 配列	スナップショットに排他的に含まれる、またはスナップショットから明示的に除外されるデータベースまたは名前空間の任意の組み合わせのコンマ区切りリスト。デフォルト値は空の配列（ `[]` ）です。
`namespaceFilterList` `.filterType`	string	このスナップショットで名前空間をフィルタリングする方法を決定するラベル。この値が`blacklist`に設定されている場合、 `namespaceFilterList.filterList`の名前空間はスナップショットから除外されます。この値が`whitelist`に設定されている場合、 `namespaceFilterList.filterList`の名前空間のみがスナップショットに含まれます。デフォルト値は `blacklist` です。
`missingShards`	オブジェクトの配列	スナップショットが欠落しているシャードのリスト。 `missingShards`はシャーディングされたクラスターのスナップショットにのみ表示されます。定常状態では、この配列は空です。スナップショットの作成時にバックアップがシャードに接続できない場合、シャードはスナップショットから省略されます。配列内の各ドキュメントは、 `self`リンクを含むクラスタードキュメントです。
`missingShards` `.id`	string	欠落しているシャードの一意の識別子。
`missingShards` `.groupId`	string	欠落しているシャードを所有するプロジェクトの一意の識別子。
`missingShards` `.typeName`	string	欠落しているシャードが表すサーバーのタイプは次のとおりです。 `CONFIG_SERVER_REPLICA_SET` `REPLICA_SET`
`missingShards` `.clusterName`	string	欠落しているシャードのクラスターの名前。
`missingShards` `.shardName`	string	欠落しているシャードの名前。
`missingShards` `.replicaSetName`	string	欠落しているシャード内のレプリカセットの名前。
`missingShards` `.lastHeartbeat`	タイムスタンプ	ISO8601 のタイムスタンプ欠落しているシャードから最後のハートビートが受信されたときの UTC の日付と時刻形式。
`parts`	オブジェクトの配列	完全なスナップショットを構成する個々の部分。レプリカセットの場合、この配列には 1 つのドキュメントが含まれます。シャーディングされたクラスターの場合、この配列にはシャードごとに 1 つのドキュメントとコンフィギュレーションサーバー用の 1 つのドキュメントが含まれます。
`parts` `.clusterId`	string	レプリカセットの一意の識別子です。
`parts` `.compressionSetting`	string	スナップショットの圧縮方法。
`parts` `.dataSizeBytes`	数値	スナップショット内のデータの合計サイズ（バイト単位）。
`parts` `.encryptionEnabled`	ブール値	スナップショットデータの暗号化状態を示すインジケーター。
`parts` `.fileSizeBytes`	数値	データファイルの合計サイズ（バイト単位）。
`parts` `.masterKeyUUID`	string	スナップショットデータを暗号化するために使用される KMIP マスターキー ID。`parts.masterKeyUUID`は、このスナップショットに`parts.encryptionEnabled : true`がある場合にのみ表示されます。
`parts` `.mongodVersion`	string	スナップショット `mongod`の作成時にレプリカセットプライマリが実行されていたのバージョン。
`parts` `.replicaSetName`	string	レプリカセットの名前。
`parts` `.storageSizeBytes`	数値	ドキュメントストレージに割り当てられた領域の合計サイズ。
`parts` `.typeName`	string	部分が表すサーバーのタイプ。 `REPLICA_SET` `CONFIG_SERVER_REPLICA_SET`

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots?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" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "clusterId" : "{CLUSTER-ID}",
    "complete" : true,
    "created" : {
      "date" : "2016-08-21T23:47:38Z",
      "increment" : 1
    },
    "doNotDelete" : false,
    "expires" : "2017-08-20T23:47:38Z",
    "groupId" : "{PROJECT-ID}",
    "id" : "{SNAPSHOT-ID}",
    "lastOplogAppliedTimestamp" : {
      "date" : "2017-08-21T09:14:51Z",
      "increment" : 1
    },
    "links" : [ {
      "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}",
      "rel" : "self"
    } ],
    "namespaceFilterList" : {
      "filterList" : [ ],
      "filterType" : "blacklist"
    },
    "parts" : [ {
      "clusterId" : "{CLUSTER-ID}",
      "compressionSetting" : "GZIP",
      "dataSizeBytes" : 503779557,
      "encryptionEnabled" : false,
      "fileSizeBytes" : 2855605344,
      "mongodVersion" : "4.0.9",
      "replicaSetName" : "proton",
      "storageSizeBytes" : 547516416,
      "typeName" : "REPLICA_SET"
    } ]
  }, {
  } ],
  "totalCount" : 28
}

戻る

スナップショット

1 つのクラスターの 1 つのスナップショットを取得