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 |
|---|---|---|
| string | Identificador único del proyecto. |
| 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 se debe devolver el cuerpo de la respuesta en un prettyprint formato. |
|
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, establezca 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
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
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 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 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" : [ "AGENT", "BACKUP" ], "created" : "2015-10-22T15:04:31Z", "description" : "new description", "endDate" : "2015-10-23T23:30:00Z", "groupId" : "{PROJECT-ID}", "id" : "5628faffd4c606594adaa3b2", "startDate" : "2015-10-23T22:00:00Z", "updated" : "2015-10-22T15:04:31Z", "links" : []}