Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece como se indica en el documento.
Cancele una solicitud de implementación de importación en curso. Este endpoint permite detener una solicitud de implementación de importación que se encuentra actualmente en ejecución. Una vez cancelado, el proceso de importación se detendrá y el estado de la solicitud cambiará a CANCELLED.
Importante
Esta funcionalidad está disponible desde Ops Manager 8.0.13.
Nota
Este endpoint solo se puede usar en solicitudes de importación que actualmente estén en curso. Usa la borrar endpoint para limpiar las solicitudes fallidas.
Roles necesarios
Este punto final requiere el rol Project Automation Admin.
Endpoint
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /automation/importDeployment/{PROJECT-ID}/{REQUEST-ID}/cancel
Solicitud
Parámetros de ruta
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Identificador único de la Proyecto. |
REQUEST-ID | string | Requerido | Identificador único de la solicitud de cancelación de la implementación de la importación. |
Parámetros de query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Devuelve una respuesta vacía de éxito con el estado HTTP 200 si se ha cancelado correctamente la solicitud de importación.
Solicitud de ejemplo
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"
Respuesta de ejemplo
Encabezado de respuesta
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}
Respuesta del cuerpo
{}