Recupera todos los períodos de mantenimiento con fechas de finalización en el futuro.
Roles necesarios
Puedes llamar eficazmente a este endpoint con cualquier rol asignado.
Solicitud
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{PROJECT-ID}/maintenanceWindows/
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del proyecto. |
Parámetros de Solicitud Query
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en el
Sección |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada resultado es un periodo de mantenimiento.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del periodo de mantenimiento. |
| string | Identificador único del Proyecto al que aplica este periodo de mantenimiento. |
| string | Fecha y hora en formato ISO 8601 de timestamp en UTC cuando se creó el periodo de mantenimiento. |
| string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC de la última vez que se actualizó el periodo de mantenimiento. |
| string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando comienza el periodo de mantenimiento. |
| string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando finaliza el periodo de mantenimiento. |
| Arreglo de cadenas | Tipos de alertas para silenciar durante el periodo de mantenimiento. Por ejemplo: |
| string | Descripción del periodo de mantenimiento. Este campo se devuelve solo si se proporcionó una descripción del periodo de mantenimiento. |
Solicitud de ejemplo
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"
Respuesta de ejemplo
Encabezado de respuesta
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}
Respuesta del cuerpo
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 }