Obter status de automação dos últimos 50 planos
Nesta página
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.
Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.
Visão geral
Recupera os 50 planos mais recentes para processos MongoDB. Os planos são um conjunto de ação necessárias para obter uma implantação do MongoDB no goalVersion.
O endpoint retorna o campo goalVersion para relatar a versão da configuração de automação que o objeto de resposta descreve e o campo lastGoalVersionAchieved para relatar as versões da configuração em execução em cada servidor.
Recurso
GET /groups/GROUP-ID/automationStatus/full
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Parâmetro | Tipo | Descrição |
|---|---|---|
ID do grupo | string | (Obrigatório.) O identificador exclusivo do grupo. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
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
Nome | Tipo | Descrição |
|---|---|---|
targetVersion | número | A versão daconfiguração de automação do . Se houver um conflito nos envios de configurações de automação, esse campo listará a configuração vencedora. |
processes | array | Instâncias MongoDB implantadas do projeto. |
process.errorCode | inteiro | O código de erro. Retorna 0 se o processo não tiver erros. |
process.errorCodeDescription | string | Descrição detalhada do erro. Retorna uma string vazia se o processo não tiver erros. |
process.errorCodeHumanReadable | string | Descrição curta do erro. Retorna uma string vazia se o processo não tiver erros. |
process.errorString | string | Saída da linha de log que contém o erro. Examine este campo para contexto de erro adicional. Retorna uma string vazia se o processo não tiver erros. |
process.hostname | string | O nome de domínio totalmente qualificado (recuperado emitindo hostname -f) do servidor no qual o processo do MongoDB e a automação estão hospedados. |
process.name | string | O nome do processo conforme especificado na configuração da automação. |
processos.lastGoalVersionAchievede | número | A última versão da configuração de automação com a qual esse processo foi distribuído como configurado. Se o número processes.lastGoalVersionAchieved não for igual ao número goalVersion , o processo ainda não foi implementado de acordo com a configuração atual. |
process.plan | array | Descreve como um processo que ainda não está atualizado com a configuração atingirá o estado da meta. |
Exemplo de solicitação
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET -i "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationStatus/full"
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
{ "goalVersion": 11, "processes": [{ "errorCode": 0, "errorCodeDescription": "", "errorCodeHumanReadable": "", "errorString": "", "hostname": "example.net", "lastGoalVersionAchieved": 11, "name": "myReplicaSet_3", "plan": ["Download", "WaitRsInit", "WaitFeatureCompatibilityVersionCorrect" ] }, { "errorCode": 100, "errorCodeDescription": "There is an issue with file permissions for this process", "errorCodeHumanReadable": "File Permissions Error", "errorString": "<myReplicaSet_1> [13:11:33.348] Failed to compute states : <myReplicaSet_1> [13:11:33.348] Error calling ComputeState : <myReplicaSet_1> [13:11:33.348] Error getting fickle state for current state : <myReplicaSet_1> [13:11:33.348] Error checking if process is running from dbpath = /data/0 : <myReplicaSet_1> [13:11:33.348] Error getting file contents of /data/0/mongod.lock as string : <myReplicaSet_1> [13:11:33.348] Error reading file from /data/0/mongod.lock : open /data/0/mongod.lock: permission denied", "hostname": "example.net", "lastGoalVersionAchieved": 1, "name": "myReplicaSet_1", "plan": ["Download"] }, { "errorCode": 0, "errorCodeDescription": "", "errorCodeHumanReadable": "", "errorString": "", "hostname": "example.net", "lastGoalVersionAchieved": 11, "name": "myReplicaSet_2", "plan": ["Download", "Start", "WaitRsInit", "WaitFeatureCompatibilityVersionCorrect", "AdjustRoles" ] }] }