Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Medições e alertas
/
Janelas de manutenção

Obter 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

Recupere um período de manutenção com uma data de término no futuro.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer função atribuída.

Solicitar

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

GET /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

PROJECT-ID

string

Identificador único do projeto.

MW-ID

string

Identificador único do período de manutenção que você deseja recuperar.

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

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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

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

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" : [ "AGENT", "BACKUP" ],
3  "created" : "2015-10-22T15:04:31Z",
4  "description" : "new description",
5  "endDate" : "2015-10-23T23:30:00Z",
6  "groupId" : "{PROJECT-ID}",
7  "id" : "5628faffd4c606594adaa3b2",
8  "startDate" : "2015-10-23T22:00:00Z",
9  "updated" : "2015-10-22T15:04:31Z",
10  "links" : []
11}

Voltar

Obter todos

Próximo

criar