注意
グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
このリソースを使用すると、チェックポイントのメタデータを表示できます。 チェックポイント を使用して、通常のスナップショット間の特定の時点でクラスターのカスタム スナップショットを作成できます。
重要
MongoDB を実行しているクラスターで、4.0 以前の Feature Compatibility Version を使用している場合は、チェックポイントを使用できます。チェックポイントは、機能の互換性バージョン 4.2 以降の MongoDB インスタンスから削除されました。
エンドポイント
すべてのチェックポイントの取得
クラスターのすべてのチェックポイントを取得します。
GET /groups/{PROJECT-ID}/clusters/CLUSTER-ID/checkpoints1 つのチェックポイントを取得
チェックポイントを 1 つ取得します。
GET /groups/{PROJECT-ID}/clusters/CLUSTER-ID/checkpoints/CHECKPOINT-IDサンプル エンティティ
{ "clusterId" : "{CLUSTER-ID}", "completed" : "2015-07-31T23:19:51Z", "groupId" : "{GROUP-ID}", "id" : "{CHECKPOINT-ID}", "parts" : [ { "replicaSetName" : "shard_1", "shardName" : "shard_1", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:19:51Z", "increment" : 1 }, "typeName" : "REPLICA_SET" }, { "replicaSetName" : "shard_0", "shardName" : "shard_0", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:19:51Z", "increment" : 1 }, "typeName" : "REPLICA_SET" }, { "hostId" : "{HOST-ID}", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:19:51Z", "increment" : 6 }, "typeName" : "CONFIG_SERVER" } ], "restorable" : true, "started" : "2015-07-31T23:19:51Z", "timestamp" : "2015-07-31T23:19:47Z"}エンティティ フィールド
名前 | タイプ | 説明 |
|---|---|---|
| string | チェックポイントによって表されるクラスターの一意の識別子です。 |
| string | チェックポイントが完了し、バランサーが再起動した時点の時点の ISO8601 日付と時刻形式(UTC)のタイムスタンプ。 |
| string | チェックポイントを所有するグループの一意の識別子です。 |
| string | チェックポイントの一意の識別子です。 |
| オブジェクトの配列 | 完全なチェックポイントを構成する個々の部分。 各シャードに 1 つの要素とコンフィギュレーションサーバーの 1 つの要素があります。 |
| string | レプリカセットの名前。 コンフィギュレーションサーバーには存在しません。 |
| string | シャードの名前。 |
| ブール値 | トークンが存在するかどうかを示すフラグ。 |
| オブジェクト | |
| string | 部分で表されるサーバーのタイプ。 可能な値は次のとおりです。
|
| ブール値 | チェックポイントを復元に使用できるかどうかを示すフラグ。 |
| string | |
| string | Timestamp in ISO 8601 date and time format in UTC for the point-in-time to which the checkpoint restores data. |
リンク
関係 | 説明 |
|---|---|
| チェックポイント |
| チェックポイントが属するクラスター。 |
| チェックポイントを所有するプロジェクト。 |
例
すべてのチェックポイントの取得
リクエスト
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-ID}/checkpoints"応答
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "links" : [], "results" : [ { "clusterId" : "{CLUSTER-ID}", "completed" : "2015-07-31T23:35:52Z", "groupId" : "{GROUP-ID}", "id" : "55bc0658e4b097a3efe06f1f", "links" : [], "parts" : [ { "replicaSetName" : "shard_1", "shardName" : "shard_1", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:35:52Z", "increment" : 1 }, "typeName" : "REPLICA_SET" }, { "replicaSetName" : "shard_0", "shardName" : "shard_0", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:35:52Z", "increment" : 1 }, "typeName" : "REPLICA_SET" }, { "hostId" : "{HOST-ID}", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:35:52Z", "increment" : 2 }, "typeName" : "CONFIG_SERVER" } ], "restorable" : true, "started" : "2015-07-31T23:35:52Z", "timestamp" : "2015-07-31T23:34:47Z" }, ... ], "totalCount" : 6}1 つのチェックポイントを取得
リクエスト
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-ID}/checkpoints/{CHECKPOINT-ID}"応答
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "clusterId" : "{CLUSTER-ID}", "completed" : "2015-07-31T23:19:51Z", "groupId" : "{GROUP-ID}", "id" : "{CHECKPOINT-ID}", "links" : [], "parts" : [ { "replicaSetName" : "shard_1", "shardName" : "shard_1", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:19:51Z", "increment" : 1 }, "typeName" : "REPLICA_SET" }, { "replicaSetName" : "shard_0", "shardName" : "shard_0", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:19:51Z", "increment" : 1 }, "typeName" : "REPLICA_SET" }, { "hostId" : "{HOST-ID}", "tokenDiscovered" : true, "tokenTimestamp" : { "date" : "2015-07-31T23:19:51Z", "increment" : 6 }, "typeName" : "CONFIG_SERVER" } ], "restorable" : true, "started" : "2015-07-31T23:19:51Z", "timestamp" : "2015-07-31T23:19:47Z"}