/ /

Recursos

Importar implantações

Página inicial do Docs

Importar implantações

Obter status da solicitação de importação de implantação

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 termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

Recuperar o status de uma solicitação específica de implantação de importação. Esse ponto de extremidade fornece informações detalhadas sobre o estado atual e o histórico de uma única solicitação de implantação de importação.

Importante

Este recurso está disponível a partir do Ops Manager 8.0.13.

Funções obrigatórias

Este ponto de extremidade requer a função Project Automation Admin.

Endpoint

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

GET /automation/importDeployment/{PROJECT-ID}/{IMPORT-PROCESS-ID}

Solicitar

parâmetros de caminho

Nome	Tipo	necessidade	Descrição
ID do projeto	string	Obrigatório	Identificador único do projeto.
IMPORT-PROCESS-ID	string	Obrigatório	Identificador único da solicitação de implantação de importação.

parâmetros de query

Os seguintes parâmetros de query são opcionais:

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`

Parâmetros do corpo

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

Resposta

Nome	Tipo	necessidade	Descrição
id	string	Sempre	Identificador único da solicitação de implantação de importação.
groupId	string	Sempre	Identificador do projeto.
ID do usuário	string	Sempre	Usuário que criou a solicitação de importação.
state	string	Sempre	Estado atual da importação. Valores possíveis: `PENDING`, `AWAIT_SEED_HOST_CONNECTED`, `AWAIT_HOSTS_DISCOVERED`, `AWAIT_AUTOMATION_IMPORTED`, `AWAIT_GOAL_STATE`, `SUCCESS`, `FAILED`, `CANCELLED`.
transactionsHistory	array	Sempre	Histórico de transições de estado para esta solicitação de importação.
transitionsHistory[n].estado	string	Sempre	O estado para o qual foi feita a transição.
transitsHistory[n].transitionedAt	string	Sempre	Carimbo de data/hora ISO 8601 em que a transição ocorreu.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}/{IMPORT-PROCESS-ID}?pretty=true"

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

{
  "id": "507f1f77bcf86cd799439011",
  "groupId": "507f1f77bcf86cd799439012",
  "userId": "507f1f77bcf86cd799439013",
  "state": "AWAIT_GOAL_STATE",
  "transitionsHistory": [
    {
      "state": "PENDING",
      "transitionedAt": "2025-10-20T10:00:00.000Z"
    },
    {
      "state": "AWAIT_SEED_HOST_CONNECTED",
      "transitionedAt": "2025-10-20T10:02:00.000Z"
    },
    {
      "state": "AWAIT_HOSTS_DISCOVERED",
      "transitionedAt": "2025-10-20T10:05:00.000Z"
    },
    {
      "state": "AWAIT_AUTOMATION_IMPORTED",
      "transitionedAt": "2025-10-20T10:08:00.000Z"
    },
    {
      "state": "AWAIT_GOAL_STATE",
      "transitionedAt": "2025-10-20T10:12:00.000Z"
    }
  ]
}

Voltar

Obter solicitações de implantação de importação

Cancelar solicitação de implantação de importação