更改一个快照的有效期
对该端点的所有请求都必须源自IP MongoDB Ops Manager用户的API 访问权限列表上的 解决。有关配置API访问权限列表的完整文档,请参阅需要为组织提供API访问列表。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}
请求参数
请求路径参数
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
| false |
请求正文参数
名称 | 类型 | 说明 |
---|---|---|
doNotDelete | 布尔 | 指示无法删除快照的指示器。 重要您不能在将 |
expires | timestamp | ISO8601 的日期 UTC 格式的日期和时间,在此之后可以删除此快照。 如果将 如果 如果当前的 |
响应
Name | 类型 | 说明 |
---|---|---|
clusterId | 字符串 | 快照所代表集群的唯一标识符。 |
complete | 布尔 | 指示快照已创建的标志。 如果快照创建作业仍在进行中,则为 false 。 |
created | 文档 | |
created .date | timestamp | iso 8601 - 拍摄快照的时间。 |
created .increment | 整型 | |
doNotDelete | 布尔 | 指示无法删除快照的标志。 |
expires | timestamp | ISO8601 格式的时间戳 UTC 格式的日期和 时间 ,之后可以删除此 快照 。 如果将 如果 |
groupId | 字符串 | |
id | 字符串 | |
isPossibly Inconsistent | 布尔 | |
lastOplog AppliedTimestamp | 文档 | 应用了最后一个 oplog 条目的时间戳组件。 |
lastOplog AppliedTimestamp .date | timestamp | |
lastOplog AppliedTimestamp .increment | 整型 | |
links | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
namespaceFilterList | 对象 | |
namespaceFilterList .filterList | 字符串数组 | 以逗号分隔的列表,其中包含以独占方式包含在快照中或显式排除在快照中的数据库或命名空间的任意组合。 默认值为空数组 ( |
namespaceFilterList .filterType | 字符串 | 用于确定如何为此快照筛选命名空间的标签。
默认值为 |
missingShards | 对象数组 | |
missingShards .id | 字符串 | 缺失分片的唯一标识符。 |
missingShards .groupId | 字符串 | 拥有缺失分片的项目的唯一标识符。 |
missingShards .typeName | 字符串 | 缺失分片代表的服务器类型:
|
missingShards .clusterName | 字符串 | 缺失分片的集群名称。 |
missingShards .shardName | 字符串 | 缺失分片的名称。 |
missingShards .replicaSetName | 字符串 | 缺失分片中副本集的名称。 |
missingShards .lastHeartbeat | timestamp | |
parts | 对象数组 | 构成完整快照的各个部分。
|
parts .clusterId | 字符串 | |
parts .compressionSetting | 字符串 | |
parts .dataSizeBytes | 数字 | 快照中数据的总大小(以字节为单位)。 |
parts .encryptionEnabled | 布尔 | 快照数据加密状态的指示器。 |
parts .fileSizeBytes | 数字 | 数据文件的总大小(以字节为单位)。 |
parts .masterKeyUUID | 字符串 | |
parts .mongodVersion | 字符串 | |
parts .replicaSetName | 字符串 | |
parts .storageSizeBytes | 数字 | 为文档存储分配的空间总大小。 |
parts .typeName | 字符串 | 该部分代表的服务器类型:
|
links
阵列
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 }'
响应示例
响应标头
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
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" } ], }