Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter um período de manutenção

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

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

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}
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.

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta está em um formato pretty-print.

false

envelope

booleano

Opcional

Sinalizador que indica se deve envolver a resposta em um envelope.

Alguns clientes de 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:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

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

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 o período de manutenção foi criado.

updated

string

Carimbo de data/hora no formato de data e hora ISO 8601 em UTC quando o período de manutenção foi atualizado pela última vez.

startDate

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o período de manutenção começa.

endDate

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o período 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 do período de manutenção. Este campo aparece apenas se você fornecer uma descrição do período de manutenção.

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/{MW-ID}"
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-alive
HTTP/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}
{ "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" : []}