Crea un periodo de mantenimiento. Ops Manager desactiva las notificaciones de alertas para ciertos tipos de alertas durante un perÃodo de tiempo especificado para permitir la realización de tareas de mantenimiento.
Roles necesarios
Puede llamar a este endpoint con éxito 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 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 muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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:
|
|
Parámetros del cuerpo de la solicitud
Body Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Arreglo de cadenas | Requerido | Tipos de alertas para silenciar durante el periodo de mantenimiento. Por ejemplo: |
| string | Requerido | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando comienza el periodo de mantenimiento. |
| string | Requerido | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando finaliza el periodo de mantenimiento. |
| string | Opcional | Descripción del periodo de mantenimiento. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del periodo de mantenimiento. |
| string | Identificador único del Proyecto al que aplica este periodo de mantenimiento. |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se creó el periodo de mantenimiento. |
| string | Marca de tiempo en ISO 8601 en formato de fecha y hora en UTC cuando el periodo de mantenimiento se actualizó por última vez. |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 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 aparece solo si proporciona una descripción del periodo de mantenimiento. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows" \ --data ' { "startDate" :"2015-10-23T22:00:00Z", "endDate" : "2015-10-23T23:30:00Z", "alertTypeNames" : [ "REPLICA_SET" ], "description" : "new description" }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "alertTypeNames" : [ "REPLICA_SET" ], "created" : "2015-10-22T20:49:35Z", "description" : "my description", "endDate" : "2015-10-23T23:30:00Z", "groupId" : "{PROJECT-ID}", "id" : "56294bdfd4c643eef5176b73", "startDate" : "2015-10-23T22:00:00Z", "updated" : "2015-10-22T20:49:35Z", "links" : []}