/ /

/ /

インポート配置リクエストのステータスを取得する

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

特定のインポート配置リクエストのステータスを取得します。このエンドポイントは、1 つのインポート配置リクエストの現在の状態と履歴に関する詳細情報を提供します。

重要

この機能は Ops Manager 8.0.13 以降で使用可能です。

必須のロール

このエンドポイントにはProject Automation Admin ロールが必要です。

エンドポイント

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /automation/importDeployment/{PROJECT-ID}/{IMPORT-PROCESS-ID}

リクエスト

path パラメータ

名前	タイプ	必要性	説明
プロジェクトID	string	必須	プロジェクトの一意の識別子です。
IMport-PROCESS- ID	string	必須	インポート配置リクエストの一意の識別子です。

クエリパラメータ

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

ボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

名前	タイプ	必要性	説明
id	string	常に	インポート配置リクエストの一意の識別子です。
グループ ID	string	常に	プロジェクト識別子。
userId	string	常に	インポートリクエストを作成したユーザー。
状態	string	常に	インポートの現在の状態。可能な値は: `PENDING`、`AWAIT_SEED_HOST_CONNECTED`、`AWAIT_HOSTS_DISCOVERED`、`AWAIT_AUTOMATION_IMPORTED`、`AWAIT_GOAL_STATE`、`SUCCESS`、`FAILED`、`CANCELLED`
transformations履歴	配列	常に	このインポートリクエストの状態遷移の履歴。
transformations履歴[n].rate	string	常に	移行された状態。
transformations履歴[n].transitionedAt	string	常に	移行が発生したときの ISO 8601 タイムスタンプ。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/automation/importDeployment/{PROJECT-ID}/{IMPORT-PROCESS-ID}?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}

レスポンス本体

{
  "id": "507f1f77bcf86cd799439011",
  "groupId": "507f1f77bcf86cd799439012",
  "userId": "507f1f77bcf86cd799439013",
  "state": "AWAIT_GOAL_STATE",
  "transitionsHistory": [
    {
      "state": "PENDING",
      "transitionedAt": "2025-10-20T10:00:00.000Z"
    },
    {
      "state": "AWAIT_SEED_HOST_CONNECTED",
      "transitionedAt": "2025-10-20T10:02:00.000Z"
    },
    {
      "state": "AWAIT_HOSTS_DISCOVERED",
      "transitionedAt": "2025-10-20T10:05:00.000Z"
    },
    {
      "state": "AWAIT_AUTOMATION_IMPORTED",
      "transitionedAt": "2025-10-20T10:08:00.000Z"
    },
    {
      "state": "AWAIT_GOAL_STATE",
      "transitionedAt": "2025-10-20T10:12:00.000Z"
    }
  ]
}

戻る

インポート配置リクエストの取得

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

注意

重要

必須のロール

エンドポイント

リクエスト

path パラメータ

クエリ パラメータ

ボディ パラメータ

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

クエリパラメータ

ボディパラメータ