Show shared disk provision service execution status details#

共有ストレージサービスAPIの任意の実行状況を表示します。

APIエンドポイント#

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

HTTPメソッドとURI#

GET

/v1/disk/{API名称1}/{API名称2}/{ジョブID}

HTTPステータスコード#

正常時：200

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

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

名前 In Type デフォルト値
/必須指定		 Description
API名称1 path string 必須 表示する実行ジョブのAPI名称を指定します。API名称1とAPI名称2の有効な組み合わせは以下のとおりです。
- accesspoint/create
- accesspoint/remove
- backuprule/create
- backuprule/change
- backupvolume/remove
- snapshot/collect
- snapshot/remove
- backupfile/remove
- volume/recover
API名称2 path string 必須 表示する実行ジョブのAPI名称を指定します。API名称1とAPI名称2の有効な組み合わせは以下のとおりです。
- accesspoint/create
- accesspoint/remove
- backuprule/create
- backuprule/change
- backupvolume/remove
- snapshot/collect
- snapshot/remove
- backupfile/remove
- volume/recover
ジョブID path integer 必須 表示するAPIのジョブIDを指定します。
TenantId query string 必須 プロジェクトID

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

名前 Type Description
jobStatus object ジョブステータス
jobStatus string ジョブのステータス情報
次のステータスを通知します。
- COMPLETED ：当該APIジョブ要求実行完了状態
- FAILED ：当該APIジョブ要求実行異常
- EXECUTING：当該APIジョブ要求実行中
startTime string 処理が開始された日時（年月日時分秒）
endTime string 処理が終了した日時（年月日時分秒）
📒注: jobStatusがEXECUTINGの場合、表示されません。
plannedExecutionTime string APIリクエストを受け付けた日時 （年月日時分秒）
userInputValues array API実行時に指定したパラメータ情報

リクエスト例#

/v1/disk/accesspoint/create/41514?TenantId=76875dbbb8244c809fe12b2f80a0e8c2

レスポンス例#

{
    "jobStatus": {
        "jobStatus": "COMPLETED",
        "startTime": "Jul 12, 2018 10:51:32 AM",
        "endTime": "Jul 12, 2018 10:52:26 AM",
        "plannedExecutionTime": "Jul 12, 2018 10:51:31 AM",
        "userInputValues": [
            {
                "key": "$RegionName",
                "value": "jp-east-3"
            },
            {
                "key": "$VolumeSizeTB",
                "value": "1.5"
            },
            {
                "key": "$IPv4",
                "value": "192.168.11.17"
            },
            {
                "key": "$VolumeName",
                "value": "testvol1"
            },
            {
                "key": "$Token",
                "value": "gAAAAABbRyusQ9HlTtUoCrRJbvSOjRlISioNlu6POLXQNqq9y_M489SnhZmplDi0QMUBNhVkzW2U_
                vCGK6Ijj60UDLXnZvex_j_MtWfwNc8UJr1Rcsw6nW8T4y158DWdUAtWhHzI8D-lO7sUOqrLxfsZ-Quu8aQdFktFfKEwjaQ2P-QkZjEzj2Y"
            },
            {
                "key": "$SubnetMask",
                "value": "255.255.255.0"
            },
            {
                "key": "$TenantId",
                "value": "76875dbbb8244c809fe12b2f80a0e8c2"
            },
            {
                "key": "$SubnetId",
                "value": "49c0f1af-2ceb-41d7-9a74-14dcbedce9f8"
            }
        ]
    }
}