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.
Cancele uma solicitação de implementação de importação em andamento. Esse endpoint permite interromper uma solicitação de implementação de importação que esteja em execução no momento. Depois de cancelado, o processo de importação será interrompido e o estado da solicitação mudará para CANCELLED.
Importante
Este recurso está disponível a partir do Ops Manager 8.0.13.
Observação
Este endpoint só pode ser usado em solicitações de importação que estão atualmente em andamento. Use o endpoint de exclusão para limpar solicitações com falha.
Funções obrigatórias
Este endpoint requer a função Project Automation Admin .
Endpoint
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /automation/importDeployment/{PROJECT-ID}/{REQUEST-ID}/cancel
Solicitar
parâmetros de caminho
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
ID do projeto | string | Obrigatório | Identificador único do projeto . |
REQUEST-ID | string | Obrigatório | Identificador exclusivo da solicitação de sistema de importação a ser cancelada. |
parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional |
| |||||||
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:
|
|
Parâmetros do corpo
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Retorna uma resposta de sucesso vazia com status HTTP 200 se a solicitação de importação for cancelada com sucesso.
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}/{REQUEST-ID}/cancel?pretty=true"
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
{}