Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

更改一个快照的有效期

在此页面上

  • Resource
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • links 阵列
  • 请求示例
  • 响应示例

对该端点的所有请求都必须源自IP MongoDB Ops Manager用户的API 访问权限列表上的 解决。有关配置API访问权限列表的完整文档,请参阅需要为组织提供API访问列表。

基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}
名称
类型
说明
PROJECT-ID
字符串
拥有 快照 的 项目 的唯一标识符。
CLUSTER-ID
字符串
快照所代表的集群的唯一标识符。
SNAPSHOT-ID
字符串

以下查询参数为可选参数:

名称
类型
必要性
说明
默认
pretty
布尔
Optional
false
envelope
布尔
Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true

对于返回一个结果的端点,响应体包括:

名称
说明
状态
HTTP 响应代码
envelope
预期响应正文
false
名称
类型
说明
doNotDelete
布尔

指示无法删除快照的指示器。

重要

您不能在将doNotDelete true设置为 的expires 同时 ,在同一请求中为 设置时间戳。如果这样做,Ops Manager 将返回错误: Cannot modify snapshot because of invalid fields.

expires
timestamp

ISO8601 的日期 UTC 格式的日期和时间,在此之后可以删除此快照。

如果将doNotDelete设置为true ,则删除expires中的任何现有值。

如果expires设置为在当前日期和时间或之前的时间戳,Ops Manager 将在下一个机会删除快照。 不保证快照会立即删除。

如果当前的expires时间戳已经过去,则无法对其进行编辑。

Name
类型
说明
clusterId
字符串
快照所代表集群的唯一标识符。
complete
布尔
指示快照已创建的标志。 如果快照创建作业仍在进行中,则为false
created
文档
created
.date
timestamp
iso 8601 - 拍摄快照的时间。
created
.increment
整型
快照在此时发生的操作顺序。 要了解时间戳在 MongoDB 中的工作原理,请参阅时间戳。
doNotDelete
布尔
指示无法删除快照的标志。
expires
timestamp

ISO8601 格式的时间戳 UTC 格式的日期和 时间 ,之后可以删除此 快照 。

如果将doNotDelete设置为true ,则删除expires中的所有值。

如果expires值早于当前日期和时间,则无法编辑。

groupId
字符串
id
字符串
isPossibly
Inconsistent
布尔

指示此快照一致性的标志。 isPossiblyInconsistent仅针对分片集群快照显示。

要拍摄处于一致状态的分片集群的快照,备份会在创建快照之前暂时关闭负载均衡器。 在某些情况下,无法及时关闭负载均衡器。 然后在负载均衡器仍在运行的情况下创建快照。

如果发生这种情况,则快照可能处于不一致状态(例如,数据块迁移可能正在进行中)。

lastOplog
AppliedTimestamp
文档
应用了最后一个 oplog 条目的时间戳组件。
lastOplog
AppliedTimestamp
.date
timestamp
ISO8601 格式的时间戳 应用最后一个 oplog 的 UTC 日期和时间格式。
lastOplog
AppliedTimestamp
.increment
整型
在此确切时间点应用最后一个oplog的操作顺序。 要了解时间戳在 MongoDB 中的工作原理,请参阅时间戳。
links
对象数组

指向子资源和/或相关资源的一个或多个链接。 响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

namespaceFilterList
对象
namespaceFilterList
.filterList
字符串数组

以逗号分隔的列表,其中包含以独占方式包含在快照中或显式排除在快照中的数据库或命名空间的任意组合。

默认值为空数组 ( [] )。

namespaceFilterList
.filterType
字符串

用于确定如何为此快照筛选命名空间的标签。

  • 如果将此值设置为blacklist ,则快照中会排除namespaceFilterList.filterList中的命名空间。

  • 如果将此值设置为whitelist ,则快照中仅包含namespaceFilterList.filterList中的命名空间。

默认值为 blacklist

missingShards
对象数组

快照缺少的分片列表。 missingShards仅针对分片集群快照显示。

在稳定状态下,该数组为空。 如果在创建快照时备份无法连接到分片,则快照中会省略该分片。 数组中的每个文档都是包含self链接的集群文档。

missingShards
.id
字符串
缺失分片的唯一标识符
missingShards
.groupId
字符串
拥有缺失分片的项目的唯一标识符
missingShards
.typeName
字符串

缺失分代表的服务器类型:

  • CONFIG_SERVER_REPLICA_SET

  • REPLICA_SET

missingShards
.clusterName
字符串
缺失分片的集群名称
missingShards
.shardName
字符串
缺失分片的名称
missingShards
.replicaSetName
字符串
missingShards
.lastHeartbeat
timestamp
ISO8601 格式的时间戳 从缺失 分 片收到最后一次心跳的 UTC 日期和时间格式 。
parts
对象数组

构成完整快照的各个部分。

parts
.clusterId
字符串
parts
.compressionSetting
字符串
parts
.dataSizeBytes
数字
快照中数据的总大小(以字节为单位)。
parts
.encryptionEnabled
布尔
快照数据加密状态的指示器。
parts
.fileSizeBytes
数字
数据文件的总大小(以字节为单位)。
parts
.masterKeyUUID
字符串
用于加密 快照 数据的 KMIP 主密钥ID 。parts.masterKeyUUID仅当此快照具有parts.encryptionEnabled : true 时,才会显示 。
parts
.mongodVersion
字符串
mongod创建 快照 时 副本集 主节点 正在运行的 版本。
parts
.replicaSetName
字符串
parts
.storageSizeBytes
数字
为文档存储分配的空间总大小。
parts
.typeName
字符串

该部分代表的服务器类型:

  • REPLICA_SET

  • CONFIG_SERVER_REPLICA_SET

links数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范 中进行了解释

关系
说明
self
此资源的 URL 端点。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}?pretty=true" \
--data '
{
"doNotDelete": 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}
{
"id" : "{SNAPSHOT-ID}",
"CLUSTER-ID" : "{CLUSTER-ID}",
"complete" : true,
"created" : {
"date" : "2014-07-09T15:24:37Z",
"increment" : 1
},
"doNotDelete" : true,
"GROUP-ID" : "{PROJECT-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" : [ {
"CLUSTER-ID" : "{CLUSTER-ID}",
"dataSizeBytes" : 17344,
"fileSizeBytes" : 67108864,
"mongodVersion" : "2.6.3",
"replicaSetName" : "rs0",
"storageSizeBytes" : 10502144,
"typeName" : "REPLICA_SET"
} ],
}

后退

获取一个集群的一张快照