Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API リソース
/
バックアップと復元
/
スナップショット

1 つのコンフィギュレーションサーバーのすべてのスナップショットを取得

項目一覧

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

重要

MongoDB 3.4 を使用する場合は非推奨

MongoDB 3.4以降、ミラーリングされたコンフィギュレーションサーバーの配置（ SCCCとも呼ばれる）はサポートされなくなりました。 次の API メソッドはSCCC コンフィギュレーションサーバーでのみ機能します。 レプリカセット コンフィギュレーションサーバー（ CSRSとも呼ばれます）は、 1 つのクラスターのすべてのスナップショットを取得する メソッドを使用します。 コンフィギュレーションサーバーを SCCC から CSRS に変換する方法については、MongoDB Server マニュアルの「 コンフィギュレーション サーバーをレプリカセットにアップグレード する 」を参照してください。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots

Request Parameters

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

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

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

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

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
false
envelope
ブール値
任意

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

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

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 Cloud 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 つのスナップショットです。

名前
タイプ
説明
clusterId
スナップショットが表すクラスターの ID。
completed
ブール値
スナップショットが作成されたことを示すインジケーター。 スナップショット作成ジョブがまだ進行中の場合、これはfalseです。
作成済み
ドキュメント
created.date
タイムスタンプ
ISO8601 でスナップショットが取得された正確な時点での UTC の日付と時刻形式。
created.increment
integer
このスナップショットが正確な時点で実行された操作順序。 MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ 」を参照してください。
doNotDelete
ブール値

スナップショットが削除できないことを示します。

doNotDeleteがtrueに設定されている場合、 expiresの値はすべて無視されます。

expires
タイムスタンプ

ISO8601 の日付 この スナップショット は削除できる UTC の日時形式。

doNotDeleteがtrueに設定されている場合、 expiresのすべての値が削除されます。

expiresの値が現在の日時より前の場合は編集できなくなります。

グループ ID
objectId
スナップショット を所有する プロジェクト の ID。
id
objectId
lastOplogApplyedTimestamp
ドキュメント
最後の oplog エントリのタイムスタンプのコンポーネントが適用されました。
lastOplogAppliedTimestamp.date
タイムスタンプ
ISO8601 で最後の oplog が適用された正確な時点 UTC の日付と時刻形式。
lastOplogAppliedTimestamp.increment
integer
この時点で正確なoplogが適用された操作順序。 MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ 」を参照してください。
Links
オブジェクト配列

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

namespaceFilterList
オブジェクト配列
この スナップショット に含まれる、または除外される 名前空間 。
namespaceFilterList.filterList
string 配列

スナップショットに排他的に含まれる、またはスナップショットから明示的に除外されるデータベースまたは名前空間の任意の組み合わせのコンマ区切りリスト。

デフォルト値は空の配列（ [] ）です。

namespaceFilterList.filterType
string

このスナップショットで名前空間をフィルタリングする方法を決定する値。

  • この値がblacklistに設定されている場合、 namespaceFilterList.filterListの名前空間はスナップショットから除外されます。

  • この値がwhitelistに設定されている場合、 namespaceFilterList.filterListの名前空間のみがスナップショットに含まれます。

デフォルト値は blacklist です。

部分
オブジェクト配列
完全なスナップショットを構成する個々の部分。 この配列には 1 つのドキュメントが含まれています。
operations.dataSizeBytes
数値
スナップショット内のデータの合計サイズ（バイト単位）。
operations.encryptionEnabled
ブール値
スナップショットデータの暗号化状態を示すインジケーター。
operations.fileSizeBytes
数値
データファイルの合計サイズ（バイト単位）。
operations.hostId
string
コンフィギュレーションサーバー の ID。
operations. MasterKeyUUID
objectId
スナップショット データの暗号化に使用されるKMIPマスター キー ID。 parts.masterKeyUUIDは、このスナップショットにparts.encryptionEnabled : trueがある場合にのみ表示されます。
operations.mongodVersion
string
スナップショットの作成時に実行されていたmongodのバージョン。
operations.storageSizeBytes
数値
ドキュメント ストレージに割り当てられた領域の合計サイズ。
operations.typeName
string

部分が表す サーバーのタイプ 。

  • CONFIG_SERVER

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-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://https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-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://https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-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 つのスナップショットを削除