Docs 菜单

Docs 主页 → MongoDB Ops Manager

获取快照计划

在此页面上

  • 资源
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

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

资源

GET /groups/{PROJECT-ID}/backupConfigs/CLUSTER-ID/snapshotSchedule

请求参数

请求路径参数

范围
类型
必要性
说明
PROJECT-ID
字符串
必需
包含具有要获取的快照安排的集群的项目的唯一标识符。
CLUSTER-ID
字符串
必需
要获取其快照安排的集群的唯一标识符。

请求查询参数

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

名称
类型
必要性
说明
默认
pretty
布尔
Optional
指示响应正文是否应采用 美观文本 的标志 格式。
false
envelope
布尔
Optional

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

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

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

名称
说明
状态
HTTP 响应代码
envelope
预期响应正文
false

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称
类型
说明
clusterCheckpointIntervalMin
数字

连续集群检查点之间的分钟数。 这仅适用于分片集群。 此数字决定了分片集群的时间点恢复粒度。 Ops Manager 可能返回15 、 30或60的值。

重要

您可以对运行特征兼容性版本为4的 MongoDB 的集群使用检查点。 0或更早版本。检查点已从FCV为4的 MongoDB 实例中删除。 2或更高版本。

clusterId
字符串
应用此备份配置的集群的唯一标识符。
dailySnapshotRetentionDays
数字

保留每日快照的天数。Ops Manager 可能返回1和365 （含）之间的值。

注意

将dailySnapshotRetentionDays设置为0将禁用此规则。

fullIncrementalDayOfWeek
字符串
Ops Manager 拍摄完整快照的星期几。这可确保在最近进行完整备份。 Ops Manager 将默认值设置为 SUNDAY 。
groupId
字符串
拥有备份配置的项目的唯一标识符。
links
对象数组

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

monthlySnapshotRetentionMonths
数字

保留月度快照的月数。Ops Manager 可能返回1和36 （含）之间的值。

注意

将monthlySnapshotRetentionMonths设置为0将禁用此规则。

pointInTimeWindowHours
数字
可以创建点快照的过去小时数。
referenceHourOfDay
数字
使用 24 小时制安排快照的时间。 Ops Manager 可能返回0和23 （含）之间的值。
referenceMinuteOfHour
数字
安排快照的小时中的分钟。 Ops Manager 可能返回0和59 （含）之间的值。
referenceTimeZoneOffset
字符串

ISO-8601 时区偏移量 Ops Manager 主机所在的位置。为避免夏令时问题，请使用 UTC 。默认值为+0000 ，相当于 UTC 。Z 也是一个受支持的值，且等效于 UTC 。

Ops Manager 会在存储之前将+0000以外的任何偏移转换为+0000 ，并相应地调整referenceHourOfDay值。

例子

您传入一个请求，其中referenceHourOfDay为5 ， referenceTimeZoneOffset为"+0200". |onprem| stores a ``referenceHourOfDay的3 ， referenceTimeZoneOffset为"+0000" 。

snapshotIntervalHours
数字
快照之间的小时数。 Ops Manager 可能返回6 、 8 、 12或24的值。
snapshotRetentionDays
数字
保留最近快照的天数。Ops Manager 可能返回2和5 （含）之间的值。
weeklySnapshotRetentionWeeks
数字

保留每周快照的周数。Ops Manager 可能返回1和52 （含）之间的值。

注意

将weeklySnapshotRetentionWeeks设置为0将禁用此规则。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule"

响应示例

响应标头

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}

响应体

1{
2  "clusterId" : "{CLUSTER-ID}",
3  "dailySnapshotRetentionDays" : 7,
4  "groupId" : "{PROJECT-ID}",
5  "links" : [],
6  "monthlySnapshotRetentionMonths" : 13,
7  "pointInTimeWindowHours": 24,
8  "snapshotIntervalHours" : 6,
9  "snapshotRetentionDays" : 2,
10  "weeklySnapshotRetentionWeeks" : 4
11}
← 快照计划
更新快照计划 →

在此页面上