List Actions For Server

サーバのアクションを一覧表示します。

APIエンドポイント

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

HTTPメソッドとURI

GET

/v2.1/{project_id}/servers/{server_id}/os-instance-actions

HTTPステータスコード

正常時:200

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

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

名前 In Type

デフォルト値

/必須指定

Description
project_id path string 必須 プロジェクトのUUID
server_id path string 必須 サーバのUUID
limit query integer 任意

クエリ結果で返却される項目の最大数

指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。

注: マイクロバージョン2.58以上を指定してください。
marker query string 任意

前回のレスポンスの最後の項目のID

limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。

注: マイクロバージョン2.58以上を指定してください。
changes-since query string 任意

サーバの最新更新日時でレスポンスを絞り込みます。

日時の入力形式は以下のISO 8601形式です。

CCYY-MM-DDThh:mm:ss±hh:mm

「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。例:2015-08-27T09:49:58-05:00

注: マイクロバージョン2.58以上を指定してください。

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

名前 Type Description
instanceActions array サーバのアクション
action string アクション名
instance_uuid string サーバのUUID
message string アクションが失敗するときのエラーメッセージ
project_id string サーバが属するプロジェクトのUUID
request_id string アクション実行時に生成される固有のID
start_time string

アクションの開始日時

日時の入力形式は以下のISO 8601形式です。

CCYY-MM-DDThh:mm:ss±hh:mm

例:2015-08-27T09:49:58-05:00

「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例に、オフセットの値は「-05:00」です。

user_id string サーバの所有者のユーザーID
updated_at string

アクションの更新日時

日時の入力形式は以下のISO 8601形式です。

CCYY-MM-DDThh:mm:ss±hh:mm

例:2015-08-27T09:49:58-05:00

「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例に、オフセットの値は「-05:00」です。

注: 表示するにはマイクロバージョン2.58以上を指定してください。
links array

アクションに関連するリンクURL

ページングデータなどがある場合だけ表示します。

注: 表示するにはマイクロバージョン2.58以上を指定してください。

レスポンス例

linksが表示されない場合
{
    "instanceActions": [
        {
            "action": "resize",
            "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
            "message": "",
            "project_id": "842",
            "request_id": "req-25517360-b757-47d3-be45-0e8d2a01b36a",
            "start_time": "2012-12-05T01:00:00.000000",
            "user_id": "789"
        },
        {
            "action": "reboot",
            "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
            "message": "",
            "project_id": "147",
            "request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
            "start_time": "2012-12-05T00:00:00.000000",
            "user_id": "789"
        }
    ]
}
linksが表示される場合
{
    "instanceActions": [
        {
            "instance_uuid": "e357e6d8-952e-4d1d-b74f-c8519e937706",
            "user_id": "fake",
            "start_time": "2017-12-07T11:07:06.088644",
            "updated_at": "2017-12-07T11:07:06.431902",
            "request_id": "req-e80018f1-c5bd-45ee-aaa9-290f2f5ef7bc",
            "action": "stop",
            "message": null,
            "project_id": "6f70656e737461636b20342065766572"
        }
    ],
    "links": [
        {
            "href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/e357e6d8-952e-4d1d-b74f-c8519e937706/os-instance-actions?limit=1&marker=req-e80018f1-c5bd-45ee-aaa9-290f2f5ef7bc",
            "rel": "next"
        }
    ]
}