Retrieve the status of the image export list#

イメージエクスポート状況の一覧を取得します。

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/imageexport{?start, limit}

HTTPステータスコード#

正常時：202

エラー時：400, 401, 403, 500, 503

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

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

レスポンスボディの説明#

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

表 1. レスポンスパラメーター一覧

名前 Type Description
exports array 同一プロジェクトにおける、export_idごとのイメージエクスポート処理状況の一覧
最大で200要素まで、新しいリクエストの順に返却します。
export_id string エクスポート処理のID
export_status string エクスポート処理状況
以下のいずれかの値をとります。
キーワード 意味
succeeded エクスポート処理が正常終了したことを示す。
failed エクスポート処理が失敗したことを示す。
processing エクスポート処理中であることを示す。
queued エクスポート処理が実行開始待ちであることを示す。
cancelling エクスポート処理が中止途中であることを示す。
canceled エクスポート処理が中止したことを示す。
processingとqueuedの状態を繰り返すことがあります。
status string エクスポート状況を取得するためのURLのパス
image_id string エクスポート対象イメージに割り当てられたID
request_time string エクスポート処理の受付日時

表 2. 失敗時のレスポンスパラメーター一覧

パラメーター名 値 説明
error_code string 詳細エラーコード
error_message string 詳細エラーメッセージ 

表 3. 詳細エラー情報一覧

ステータスコード 詳細エラーコード 詳細エラーメッセージ 対処方法
400 40013 Query parameter 'start' has invalid value. リクエスト内容を修正します。
400 40014 Query parameter 'limit' has invalid value. リクエスト内容を修正します。
403 40301 You cannot execute this API. アカウントの権限を管理者に確認します。
500 50001 Internal server error. サポートに連絡してください。
500 50002 Internal server error. サポートに連絡してください。

レスポンス例#

       {
        "exports":[
         {
          "export_id":"6bf65660-70ee-4a75-b61a-36ac040c289c",
          "export_status":"succeeded",
          "status":"/v2/imageexport/6bf65660-70ee-4a75-b61a-36ac040c289c/status",
          "image_id":"ce050928-bdc2-4c15-95dc-be6fbc7d6d83",
          "request_time":"2016-04-25T00:10:24Z"
         },
         {
          "export_id":"c6cb3e62-9b4c-4cd0-971d-2b43a63196bb",
          "export_status":"failed",
          "status":"/v2/imageexport/c6cb3e62-9b4c-4cd0-971d-2b43a63196bb/status",
          "image_id":"944997d2-0b74-11e6-a963-000c29a90136",
          "request_time":"2016-04-22T00:10:24Z"
         }
        ]
       }