List Image Registration Statuses#

イメージの登録状況の一覧を取得します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://import-export.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://import-export.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v1/imageimport{?start, limit}

HTTPステータスコード#

正常時:200

エラー時:400,401,403,500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 Identityサービスを使用して取得したトークン
start query integer 任意 一覧を取得開始する先頭インデックスを指定します。
省略した場合は、リクエスト日時が最も新しい処理情報から返却されます。
limit query integer 任意 一覧取得する件数を指定します。
省略した場合は、指定したトークンに対応するすべての処理情報が返却されます。

レスポンスボディ(正常系)の説明#

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

レスポンス例#

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