/ /

Recursos

Importar sistemas

Página inicial do Docs

Obter solicitações de sistema de importaçã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 grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

Recupere todas as solicitações de implementação de importação de um projeto. Esse endpoint retorna uma lista de todas as solicitações de implementação de importação que foram criadas para o projeto especificado, incluindo seu status e histórico atuais.

Importante

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

Funções obrigatórias

Esse endpoint requer a Project Automation Admin função .

Endpoint

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

GET /automation/importDeployment/{PROJECT-ID}

Solicitar

parâmetros de caminho

Nome	Tipo	necessidade	Descrição
ID do projeto	string	Obrigatório	Identificador único do projeto .

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 deve estar em um formato de impressão bonita.

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

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

Resposta

Nome	Tipo	necessidade	Descrição
Resultados	array	Sempre	Array de objetos de solicitação de sistema de importação.
resultados[n].id	string	Sempre	Identificador único do pedido de sistema de importação.
resultados[n].groupId	string	Sempre	Identificador do projeto.
resultados[n].userId	string	Sempre	Usuário que criou a solicitação de importação.
resultados[n].estado	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`.
results[n].transitionsHistory	array	Sempre	Histórico de transições de estado para esta solicitação de importação.
results[n].transitionsHistory[n].state	string	Sempre	O estado para o qual foi feita a transição.
results[n].transitionsHistory[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}?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

{
  "results": [
    {
      "id": "507f1f77bcf86cd799439011",
      "groupId": "507f1f77bcf86cd799439012",
      "userId": "507f1f77bcf86cd799439013",
      "state": "SUCCESS",
      "transitionsHistory": [
        {
          "state": "PENDING",
          "transitionedAt": "2025-10-20T10:00:00.000Z"
        },
        {
          "state": "AWAIT_SEED_HOST_CONNECTED",
          "transitionedAt": "2025-10-20T10:02:00.000Z"
        },
        {
          "state": "SUCCESS",
          "transitionedAt": "2025-10-20T10:15:00.000Z"
        }
      ]
    }
  ]
}

Voltar

Criar Solicitação de Sistema de Importação

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