Criar um período de manutenção

Nesta página

Funções obrigatórias

Solicitar
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

Crie uma período de manutenção. O Cloud Manager desativa as notificações de alerta para determinados tipos de alerta por um período de tempo especificado para permitir a ocorrência de manutenção.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer um dos seguintes roles atribuídos:

Solicitar

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

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

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
`PROJECT-ID`	string	Identificador único do projeto.

Solicitar parâmetros de query

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Parâmetro do corpo	Tipo	necessidade	Descrição
`alertTypeNames`	array de strings	Obrigatório	Tipos de alerta para silenciar durante a janela de manutenção. Por exemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`startDate`	string	Obrigatório	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a janela de manutenção é iniciada.
`endDate`	string	Obrigatório	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a janela de manutenção termina.
`description`	string	Opcional	Descrição do período de manutenção.

Resposta

Nome	Tipo	Descrição
`id`	string	Identificador único do período de manutenção.
`groupId`	string	Identificador único do projeto ao qual este período de manutenção se aplica.
`created`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a janela de manutenção foi criada.
`updated`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a janela de manutenção foi atualizada pela última vez.
`startDate`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a janela de manutenção é iniciada.
`endDate`	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a janela de manutenção termina.
`alertTypeNames`	array de strings	Tipos de alerta para silenciar durante a janela de manutenção. Por exemplo: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`description`	string	Descrição da janela de manutenção. Este campo será retornado somente se você fornecer uma descrição da janela de manutenção.

Exemplo de solicitação

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        }'

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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 }

Voltar

Pegue um

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	}