Crear un periodo de mantenimiento

Crea un periodo de mantenimiento. Cloud Manager desactiva las notificaciones de alerta para ciertos tipos de alertas durante un periodo de tiempo especificado, permitiendo que se realice el mantenimiento.

Roles necesarios

Puede llamar a este endpoint con éxito con cualquiera de los siguientes roles asignados:

Solicitud

URL base: https://cloud.mongodb.com/api/public/v1.0

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

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	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 debe estar en formato prettyprint.

false

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:

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

false

Parámetros del cuerpo de la solicitud

Body Parameter	Tipo	Necesidad	Descripción
`alertTypeNames`	Arreglo de cadenas	Requerido	Tipos de alertas para silenciar durante el periodo de mantenimiento. Por ejemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`startDate`	string	Requerido	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando comienza la ventana de mantenimiento.
`endDate`	string	Requerido	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finaliza la ventana de mantenimiento.
`description`	string	Opcional	Descripción del periodo de mantenimiento.

Respuesta

Nombre	Tipo	Descripción
`id`	string	Identificador único del periodo de mantenimiento.
`groupId`	string	Identificador único del Proyecto al que aplica este periodo de mantenimiento.
`created`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se creó la ventana de mantenimiento.
`updated`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se actualizó por última vez la ventana de mantenimiento.
`startDate`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando comienza la ventana de mantenimiento.
`endDate`	string	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finaliza la ventana de mantenimiento.
`alertTypeNames`	Arreglo de cadenas	Tipos de alertas para silenciar durante el periodo de mantenimiento. Por ejemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`description`	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

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://cloud.mongodb.com/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" : [ "HOST", "REPLICA_SET" ],
11          "description" : "new description"
12        }'

Respuesta de ejemplo

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}

Respuesta del cuerpo

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

Obtenga 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://cloud.mongodb.com/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" : [ "HOST", "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	}