イメージ登録状況一覧取得

URL

/v1/imageimport{?start, limit}

クエリパラメーターの一覧をクエリパラメーター一覧に示す。

表 1. クエリパラメーター一覧
パラメーター名	値	説明
start（省略可）	int	一覧を取得開始する先頭インデックスを指定する。省略した場合は、リクエスト日時が最も新しい処理情報から返却する。
limit（省略可）	int	一覧取得する件数を指定する。省略した場合は、指定したトークンに対応するすべての処理情報を返却する。

Method

GET

リクエストヘッダー

本APIが受け取るリクエストヘッダーの一覧をリクエストヘッダー一覧に示す。

表 2. リクエストヘッダー一覧
リクエストヘッダー名	値	説明
X-Auth-Token	String	Identityサービスを使用して取得したトークン。

リクエストボディ

本APIはリクエストボディを受け取らない。指定した場合は無視される。

レスポンスボディ

本APIが返却するパラメーターの一覧をレスポンスパラメーター一覧および失敗時のレスポンスパラメーター一覧に示す。レスポンスボディはJSON形式で出力される。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示す。

表 3. レスポンスパラメーター一覧
パラメーター名		値	説明
imports		配列	仮想サーバインポート処理一覧のルート要素。配列の要素として、指定したトークンのプロジェクトIDに一致する処理情報を返却する。最大で100要素まで返却し、リクエストの新しい順に返却する。
	import_id	String	インポート処理のID。
	import_status	String	インポート処理状況。以下のいずれかの値をとる。キーワード意味 succeeded: インポート処理が正常終了したことを示す。 failed: インポート処理が失敗したことを示す。 processing: インポート処理中であることを示す。 queued: インポート処理実行開始待ちであることを示す。
	status	String	登録状況を取得するためのURL。

表 4. 失敗時のレスポンスパラメーター一覧
パラメーター名	値	説明
error_code	String	詳細エラーコード。
message	String	詳細エラーメッセージ。

表 5. 詳細エラー情報一覧
ステータスコード	詳細エラーコード	詳細エラーメッセージ	対処方法
400	40035	Query parameter 'start' has invalid value.	リクエスト内容を修正する。
400	40036	Query parameter 'limit' has invalid value.	リクエスト内容を修正する。
403	40301	You cannot execute this API.	アカウントの権限を管理者に確認する。
500	50001	Internal server error.	サポートに連絡する。
500	50002	Internal server error.	サポートに連絡する。

ステータスコード

本APIが返却するステータスコードの一覧をステータスコード一覧に示す。

表 6. ステータスコード一覧
ステータスコード	説明
200	仮想サーバインポート処理状況の取得が成功したことを示す。
400	リクエストが不正であることを示す。
401	トークンが不正であることを示す。
403	仮想サーバインポートの実行権限が存在しないことを示す。
500	内部エラーにより仮想サーバインポート処理一覧の取得が失敗したことを示す。

レスポンスボディ例

レスポンスボディの例を以下に示す。

{
  "imports":[
    {
      "import_id":"6bf65660-70ee-4a75-b61a-36ac040c289c",
      "import_status":"succeeded",
      "status":"/v1/imageimport/6bf65660-70ee-4a75-b61a-36ac040c289c/status"
    },
    {
      "import_id":"c6cb3e62-9b4c-4cd0-971d-2b43a63196bb",
      "import_status":"failed",
      "status":"/v1/imageimport/c6cb3e62-9b4c-4cd0-971d-2b43a63196bb/status"
    }
  ]
}