List jobs#

ジョブを一覧表示します。

APIエンドポイント#

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

HTTPメソッドとURI#

GET

/v1/archive/{project_id}/jobs

HTTPステータスコード#

正常時：200

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

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

名前 In Type デフォルト値
/必須指定		 説明
project_id path string 必須 プロジェクトID
limit query integer 任意 表示するジョブの最大件数
- 指定可能値：1～100(整数)
- 指定なし：10
サービス全体の使用状況により、指定された件数よりも少ないジョブが表示される可能性があります。

レスポンスボディ（正常系）の説明#

名前 Type 説明
jobs array ジョブオブジェクトの配列
api_name string API名称
created_at string ジョブの作成日時
ended_at string ジョブの終了日時
statusがEXECUTINGの場合は表示されません。
error_message string エラーメッセージ
statusがFAILED以外の場合は表示されません。
id integer ジョブID
project_id string プロジェクトID
request_parameter object API実行時のリクエストパラメータ
started_at string ジョブの開始日時
ジョブが作成された直後の場合は表示されません。
status string ステータス情報
- EXECUTING：実行中
- COMPLETED：実行完了
- FAILED：実行エラー

リクエスト例#

リクエスト 

GET /v1/archive/61111111aaaa2222bbbb333333333333/jobs

レスポンス例#

レスポンスボディ 

{
    "jobs": [
        {
            "api_name": "Archive Revert a storage to a snapshot",
            "created_at": "2020-07-10T11:47:39Z",
            "ended_at": "2020-07-10T11:48:18Z",
            "error_message": "An internal error has occurred.",
            "id": 49,
            "project_id": "61111111aaaa2222bbbb333333333333",
            "request_parameter": {
                "snapshot": {
                    "id": "e854c75c-bfad-4bec-aae9-5a01ff98fee3"
                }
            },
            "started_at": "2020-07-10T11:47:45Z",
            "status": "FAILED"
        },
        {
            "api_name": "Archive Delete a snapshot",
            "created_at": "2020-07-10T11:47:16Z",
            "ended_at": "2020-07-10T11:47:54Z",
            "id": 6182,
            "project_id": "61111111aaaa2222bbbb333333333333",
            "request_parameter": {
                "snapshot": {
                    "id": "b24939a3-eeb7-44cd-96fc-7d01d9c0f23e"
                }
            },
            "started_at": "2020-07-10T11:47:21Z",
            "status": "COMPLETED"
        }
    ]
}