Docs Home

/ /

Windows de mantenimiento

Docs Home

/ /

Mediciones y alertas

Windows de mantenimiento

Windows de mantenimiento

Obtener un periodo de mantenimiento

Recupera un periodo de mantenimiento con una fecha 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/{MW-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del proyecto.
`MW-ID`	string	Identificador exclusivo del periodo de mantenimiento que desea recuperar.

Parámetros de Solicitud Query

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`id`	string	Identificador único del periodo de mantenimiento.
`groupId`	string	Identificador único del Proyecto al que aplica este periodo de mantenimiento.
`created`	string	Fecha y hora en formato ISO 8601 de timestamp en UTC cuando se creó el periodo de mantenimiento.
`updated`	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.
`startDate`	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando comienza el periodo de mantenimiento.
`endDate`	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando finaliza el periodo de mantenimiento.
`alertTypeNames`	Arreglo de cadenas	Tipos de alertas para silenciar durante el periodo de mantenimiento. Por ejemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`description`	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/{MW-ID}"

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

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 }

Volver

Obtener todo

Crear

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	}