注意
グループとプロジェクトは同義語です。 あなたの {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
リクエスト
path パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | |
REQUEST- ID | string | 必須 | キャンセルするインポート配置リクエストの一意の識別子です。 |
クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
ボディ パラメータ
このエンドポイントは、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"
応答例
応答ヘッダー
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}
レスポンス本体
{}