创建一个维护窗口

在此页面上

所需角色

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

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth2.0 身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

创建一个维护窗口。 Cloud Manager会在您指定的时间内关闭某些警报类型的警报通知，以允许进行维护。

所需角色

您可以使用以下任何分配的角色成功调用此端点：

请求

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

POST /groups/{PROJECT-ID}/maintenanceWindows/

请求路径参数

名称	类型	说明
`PROJECT-ID`	字符串	项目的唯一标识符。

请求查询参数

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观打印的标志格式。

false

envelope

布尔

Optional

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

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

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

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

正文参数	类型	必要性	说明
`alertTypeNames`	字符串数组	必需	在维护窗口期间保持静默的警报类型。例如： `HOST` 、 `REPLICA_SET` 、 `CLUSTER` 、 `AGENT` 、 `BACKUP`
`startDate`	字符串	必需	ISO8601 格式的时间戳维护窗口启动时的日期和时间格式（ UTC 格式）。
`endDate`	字符串	必需	ISO8601 格式的时间戳维护窗口结束时的日期和时间格式（ UTC 格式）。
`description`	字符串	Optional	维护窗口的描述。

响应

名称	类型	说明
`id`	字符串	维护窗口的唯一标识符。
`groupId`	字符串	此维护窗口适用的项目的唯一标识符。
`created`	字符串	ISO8601 格式的时间戳创建维护窗口时的日期和时间格式（ UTC 格式）。
`updated`	字符串	ISO8601 格式的时间戳上次更新维护窗口的日期和时间格式（ UTC 格式）。
`startDate`	字符串	ISO8601 格式的时间戳维护窗口启动时的日期和时间格式（ UTC 格式）。
`endDate`	字符串	ISO8601 格式的时间戳维护窗口结束时的日期和时间格式（ UTC 格式）。
`alertTypeNames`	字符串数组	在维护窗口期间保持静默的警报类型。例如： `HOST` 、 `REPLICA_SET` 、 `CLUSTER` 、 `AGENT` 、 `BACKUP`
`description`	字符串	维护窗口的描述。仅当您提供维护窗口的说明时才会返回此字段。

请求示例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows" \
6      --data '
7        {
8          "startDate" :"2015-10-23T22:00:00Z",
9          "endDate" : "2015-10-23T23:30:00Z",
10          "alertTypeNames" : [ "HOST", "REPLICA_SET" ],
11          "description" : "new description"
12        }'

响应示例

响应标头

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   "alertTypeNames" : [ "REPLICA_SET" ],
3   "created" : "2015-10-22T20:49:35Z",
4   "description" : "my description",
5   "endDate" : "2015-10-23T23:30:00Z",
6   "groupId" : "{PROJECT-ID}",
7   "id" : "56294bdfd4c643eef5176b73",
8   "startDate" : "2015-10-23T22:00:00Z",
9   "updated" : "2015-10-22T20:49:35Z",
10   "links" : []
11 }

后退

获取一个

来年

Update

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows" \
6	--data '
7	{
8	"startDate" :"2015-10-23T22:00:00Z",
9	"endDate" : "2015-10-23T23:30:00Z",
10	"alertTypeNames" : [ "HOST", "REPLICA_SET" ],
11	"description" : "new description"
12	}'

1	{
2	"alertTypeNames" : [ "REPLICA_SET" ],
3	"created" : "2015-10-22T20:49:35Z",
4	"description" : "my description",
5	"endDate" : "2015-10-23T23:30:00Z",
6	"groupId" : "{PROJECT-ID}",
7	"id" : "56294bdfd4c643eef5176b73",
8	"startDate" : "2015-10-23T22:00:00Z",
9	"updated" : "2015-10-22T20:49:35Z",
10	"links" : []
11	}