Obter todas as janelas de manutenção
Nesta página
Recupere todos os períodos de manutenção com datas 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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /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:
| false |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
documento de resposta
O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.
Nome | Tipo | Descrição |
---|---|---|
results | array | A array inclui um objeto para cada item detalhado na seção Documento incorporado results . |
links | array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web. |
totalCount | número | Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado. |
results
documento incorporado
Cada resultado é uma janela de manutenção.
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://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows"
Exemplo de resposta
Cabeçalho de resposta
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
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 "results" : [ { 3 "alertTypeNames" : [ "BACKUP" ], 4 "created" : "2015-10-22T15:04:31Z", 5 "description" : "new description", 6 "endDate" : "2015-10-23T23:30:00Z", 7 "groupId" : "{PROJECT-ID}", 8 "id" : "5628faffd4c606594adaa3b2", 9 "startDate" : "2015-10-23T22:00:00Z", 10 "updated" : "2015-10-22T15:04:31Z", 11 "links" : [] 12 }, { 13 "alertTypeNames" : [ "AGENT", "BACKUP" ], 14 "created" : "2015-10-22T15:40:09Z", 15 "endDate" : "2015-10-23T23:30:00Z", 16 "groupId" : "{PROJECT-ID}", 17 "id" : "56290359d4c606594adaafe8", 18 "startDate" : "2015-10-23T22:00:00Z", 19 "updated" : "2015-10-22T15:40:09Z", 20 "links" : [] 21 } ], 22 "links" : [], 23 "totalCount" : 2 24 }