Docs Home

/ /

Windows de mantenimiento

Docs Home

/ /

Mediciones y alertas

Windows de mantenimiento

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Mediciones y alertas

Windows de mantenimiento

Obtenga una ventana de mantenimiento

Recupere una ventana de mantenimiento con una fecha de finalización en el futuro.

Roles necesarios

Puede llamar a este punto final con éxito con cualquier rol asignado.

Solicitud

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

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

Parámetros de la ruta de solicitud

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

Parámetros de consulta de solicitud

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Opcional

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

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

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

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

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`id`	string	Identificador único de la ventana de mantenimiento.
`groupId`	string	Identificador único del proyecto al que se aplica esta ventana de mantenimiento.
`created`	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se creó la ventana de mantenimiento.
`updated`	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó por última vez la ventana de mantenimiento.
`startDate`	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se inicia la ventana de mantenimiento.
`endDate`	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando finaliza la ventana de mantenimiento.
`alertTypeNames`	matriz de cadenas	Tipos de alertas que se silenciarán durante el periodo de mantenimiento. Por ejemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`description`	string	Descripción de la ventana de mantenimiento. Este campo solo se devuelve si se proporcionó una descripción de la ventana de mantenimiento.

Ejemplo de solicitud

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

Ejemplo de respuesta

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}

Cuerpo de respuesta

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	}