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

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

項目一覧

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

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

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

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

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

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

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

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false
completed
string
任意

完了したスナップショットまたは不完全なスナップショットのどちらを返すかを示す string。

  • true: 完了したスナップショットのみを返します

  • false: 不完全なスナップショットのみを返します

  • all: 完了したスナップショットと不完全なスナップショットの両方を返します

true

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

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

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

結果は 1 つの同期ストアです。

Name
タイプ
説明
clusterId
string
スナップショットが表すクラスターの一意の識別子。
complete
ブール値
スナップショットが作成されたことを示すフラグ。 スナップショット作成ジョブがまだ進行中の場合、これはfalseです。
created
ドキュメント
created
.date
タイムスタンプ
スナップショットが作成されたときの iso 8601 -time。
created
.increment
integer
このスナップショットが正確な時点で実行された操作順序。 MongoDB でタイムスタンプの仕組みについては、「タイムスタンプ 」を参照してください。
doNotDelete
ブール値
スナップショットが削除できないことを示すフラグ。
expires
タイムスタンプ

ISO8601 のタイムスタンプ この スナップショット を削除できる UTC の UTC の日付と時刻形式。

doNotDeletetrueに設定されている場合、 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

  • CONFIG_SHARD_REPLICA_SET

missingShards
.clusterName
string
missingShards
.shardName
string
欠落しているシャードの名前。
missingShards
.replicaSetName
string
missingShards
.lastHeartbeat
タイムスタンプ
ISO8601 のタイムスタンプ 欠落している シャード から最後のハートビートが受信されたときの UTC の日付と 時刻 形式。
parts
オブジェクトの配列

完全なスナップショットを構成する個々の部分。

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

  • CONFIG_SHARD_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
}

戻る

スナップショット