Docs 菜单

创建按需快照

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

POST /groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot

您必须具有Global Backup Admin 才能拍摄按需快照。

名称
类型
说明

群组 ID(group ID)

字符串

项目设置中项目的唯一标识符。

CLUSTER-ID

字符串

快照表示的集群的唯一标识符。

名称
类型
必要性
说明
例子

retentionDays

数字

必需

指示快照按需保留天数的整数。必须大于 0。

15

envelope

布尔

Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 envelope : true

对于返回结果列表的端点, results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

false

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--include \
--request POST "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot"
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}
{
"clusterName": "myCluster",
"description": "On demand snapshot request complete .",
"timestamp": {
"increment": 1,
"time": 1719518976,
"date": "2024-06-27T20:09:36Z"
}
}