Recupera todos los períodos de mantenimiento con fechas 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/
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| 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 formato prettyprint formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en el
Sección |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada resultado es una ventana de mantenimiento.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único de la ventana de mantenimiento. |
| string | Identificador único del proyecto al que se aplica esta ventana de mantenimiento. |
| string | Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se creó la ventana de mantenimiento. |
| string | Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se actualizó por última vez la ventana de mantenimiento. |
| string | Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando se inicia la ventana de mantenimiento. |
| string | Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando finaliza la ventana de mantenimiento. |
| matriz de cadenas | Tipos de alertas que se silenciarán durante el periodo de mantenimiento. Por ejemplo: |
| 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"
Ejemplo de respuesta
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}
Cuerpo de respuesta
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 }