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

Crear una ventana de mantenimiento

Cree una ventana de mantenimiento. Ops Manager desactiva las notificaciones de alertas para ciertos tipos de alerta durante el tiempo que especifique para permitir el mantenimiento.

Roles necesarios

Puede llamar correctamente a este punto final con cualquiera de los siguientes roles asignados:

Solicitud

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

POST /groups/{PROJECT-ID}/maintenanceWindows/

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del proyecto.

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
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Body Parameter	Tipo	Necesidad	Descripción
`alertTypeNames`	matriz de cadenas	Requerido	Tipos de alertas que se silenciarán durante el periodo de mantenimiento. Por ejemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`startDate`	string	Requerido	Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts.
`endDate`	string	Requerido	Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends.
`description`	string	Opcional	Descripción de la ventana de mantenimiento.

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	Timestamp in ISO 8601 date and time format in UTC when the maintenance window was created.
`updated`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window was last updated.
`startDate`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts.
`endDate`	string	Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends.
`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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows" \
6      --data '
7        {
8          "startDate" :"2015-10-23T22:00:00Z",
9          "endDate" : "2015-10-23T23:30:00Z",
10          "alertTypeNames" : [ "REPLICA_SET" ],
11          "description" : "new description"
12        }'

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" : [ "REPLICA_SET" ],
3   "created" : "2015-10-22T20:49:35Z",
4   "description" : "my description",
5   "endDate" : "2015-10-23T23:30:00Z",
6   "groupId" : "{PROJECT-ID}",
7   "id" : "56294bdfd4c643eef5176b73",
8   "startDate" : "2015-10-23T22:00:00Z",
9   "updated" : "2015-10-22T20:49:35Z",
10   "links" : []
11 }

Volver

Consigue uno

Update

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows" \
6	--data '
7	{
8	"startDate" :"2015-10-23T22:00:00Z",
9	"endDate" : "2015-10-23T23:30:00Z",
10	"alertTypeNames" : [ "REPLICA_SET" ],
11	"description" : "new description"
12	}'

1	{
2	"alertTypeNames" : [ "REPLICA_SET" ],
3	"created" : "2015-10-22T20:49:35Z",
4	"description" : "my description",
5	"endDate" : "2015-10-23T23:30:00Z",
6	"groupId" : "{PROJECT-ID}",
7	"id" : "56294bdfd4c643eef5176b73",
8	"startDate" : "2015-10-23T22:00:00Z",
9	"updated" : "2015-10-22T20:49:35Z",
10	"links" : []
11	}