注意
群组和项目是同义术语。 您的 {PROJECT-ID} 与您的群组 ID(group ID)相同。对于现有群组,您的群组/项目 ID 保持不变。当引用说明时,此页面使用更为人熟知的术语“群组”。终结点保持不变,如文档中所述。
此资源允许您查看检查点元数据。 您可以使用检查点在常规快照之间的时间点创建集群的自定义快照。
重要
您可以对运行 Feature Compatibility Version 为 4.0 或更早版本的 MongoDB 的集群使用检查点。检查点已从 特征兼容性版本 为 4.2 或更高版本的 MongoDB 实例中删除。
端点
获取所有检查点
获取集群的所有检查点。
GET /groups/{PROJECT-ID}/clusters/CLUSTER-ID/checkpoints获取一个检查点
获取单个检查点。
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"}实体字段
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 检查点表示的集群的唯一标识符。 |
| 字符串 | 检查点完成且负载均衡器重新启动时的时间点的 ISO 8601 日期和时间格式(UTC 格式)的时间戳。 |
| 字符串 | 拥有检查点的群组的唯一标识符。 |
| 字符串 | 检查点的唯一标识符。 |
| 对象数组 | 构成完整检查点的各个部分。 每个分片都有一个元素,外加一个配置服务器元素。 |
| 字符串 | 副本集的名称。 对于配置服务器不存在。 |
| 字符串 | 分片的名称。 |
| 布尔 | 指示令牌是否存在的标志。 |
| 对象 | |
| 字符串 | 该部分表示的服务器类型。 可能的值为:
|
| 布尔 | 指示检查点是否可用于恢复的标志。 |
| 字符串 | |
| 字符串 | 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}获取一个检查点
请求
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"}