AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

インポート配置リクエストをキャンセル

注意

グループとプロジェクトは同義語です。あなたの {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
名前
タイプ
必要性
説明

プロジェクトID

string

必須

プロジェクトの一意の識別子です。

リクエスト- ID

string

必須

キャンセルするインポート配置リクエストの一意の識別子です。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • 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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{}