Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
测量和警报
/
维护窗口

获取一个维护窗口

在此页面上

  • 所需角色
  • 请求
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

检索结束日期为将来的一个维护窗口。

所需角色

您可以使用任何指定角色成功调用该端点。

请求

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

GET /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}

请求路径参数

名称
类型
说明
PROJECT-ID
字符串
项目的唯一标识符。
MW-ID
字符串
要检索的维护窗口的唯一标识符。

请求查询参数

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

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

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

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

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

请求正文参数

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

响应

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

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}"

响应示例

响应标头

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" : [ "AGENT", "BACKUP" ],
3  "created" : "2015-10-22T15:04:31Z",
4  "description" : "new description",
5  "endDate" : "2015-10-23T23:30:00Z",
6  "groupId" : "{PROJECT-ID}",
7  "id" : "5628faffd4c606594adaa3b2",
8  "startDate" : "2015-10-23T22:00:00Z",
9  "updated" : "2015-10-22T15:04:31Z",
10  "links" : []
11}

后退

获取全部

来年

创建