获取所有维护Windows
检索结束日期在未来的所有维护窗口。
所需角色
您可以使用任何指定角色成功调用该端点。
请求
基本URL： 云1.0
GET /groups/{PROJECT-ID}/maintenanceWindows/
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
PROJECT-ID | 字符串 | 项目的唯一标识符。 |
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
|---|---|---|
results | 阵列 | 数组为 results嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
每个结果都是一个维护窗口。
名称 | 类型 | 说明 |
|---|---|---|
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"
响应示例
响应标头
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}
响应体
1 { 2 "results" : [ { 3 "alertTypeNames" : [ "BACKUP" ], 4 "created" : "2015-10-22T15:04:31Z", 5 "description" : "new description", 6 "endDate" : "2015-10-23T23:30:00Z", 7 "groupId" : "{PROJECT-ID}", 8 "id" : "5628faffd4c606594adaa3b2", 9 "startDate" : "2015-10-23T22:00:00Z", 10 "updated" : "2015-10-22T15:04:31Z", 11 "links" : [] 12 }, { 13 "alertTypeNames" : [ "AGENT", "BACKUP" ], 14 "created" : "2015-10-22T15:40:09Z", 15 "endDate" : "2015-10-23T23:30:00Z", 16 "groupId" : "{PROJECT-ID}", 17 "id" : "56290359d4c606594adaafe8", 18 "startDate" : "2015-10-23T22:00:00Z", 19 "updated" : "2015-10-22T15:40:09Z", 20 "links" : [] 21 } ], 22 "links" : [], 23 "totalCount" : 2 24 }