/ /

/ /

取消导入部署请求

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

取消正在进行的导入部署请求。此端点允许您停止当前正在运行的导入部署请求。取消后，导入进程将停止，请求状态将更改为 CANCELLED。

重要

从Ops Manager 8.0.13 开始提供此功能。

注意

此端点只能用于当前正在进行的导入请求。使用删除端点清理失败的请求。

所需角色

此端点需要Project Automation Admin 角色。

端点

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /automation/importDeployment/{PROJECT-ID}/{REQUEST-ID}/cancel

请求

路径参数

名称	类型	必要性	说明
PROJECT-ID	字符串	必需	项目的唯一标识符。
REQUEST- ID	字符串	必需	要取消的导入部署请求的唯一标识符。

查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观打印格式的标志。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

正文参数

此端点不使用 HTTP 请求正文参数。

响应

如果成功取消导入请求，则返回具有HTTP状态 200 的空成功响应。

请求示例

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"

响应示例

响应标头

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}

响应体

{}

后退

获取导入部署请求状态

来年

删除导入部署请求