イメージエクスポート状況一覧取得

URL

/v1/imageexport{?start, limit}

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

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

※件数に200以上の値を指定して取得することも可能

Method

GET

リクエストヘッダー

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

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

リクエストボディ

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

レスポンスボディ

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

表 3. レスポンスパラメーター一覧
パラメーター名 値 説明
exports 配列 同一プロジェクトにおける、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 エクスポート処理の受付日時。

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

表 5. 詳細エラー情報一覧
ステータスコード 詳細エラーコード 詳細エラーメッセージ 対処方法
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. サポートに連絡する。

ステータスコード

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

表 6. ステータスコード一覧
ステータスコード 説明
200 イメージエクスポート状況一覧の取得が成功したことを示す。
400 リクエストが不正であることを示す。
401 トークンが不正であることを示す。
403 イメージエクスポート状況一覧取得APIの実行権限がないことを示す。
405 不正なメソッドによるアクセスであることを示す。
500 内部エラーによりイメージエクスポート状況一覧の取得が失敗したことを示す。

レスポンスボディ例

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


       {
        "exports":[
         {
          "export_id":"6bf65660-70ee-4a75-b61a-36ac040c289c",
          "export_status":"succeeded",
          "status":"/v1/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":"/v1/imageexport/c6cb3e62-9b4c-4cd0-971d-2b43a63196bb/status",
          "image_id":"944997d2-0b74-11e6-a963-000c29a90136",
          "request_time":"2016-04-22T00:10:24Z"
         }
        ]
       }