List Messages

メッセージを一覧表示します。

APIエンドポイント

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

HTTPメソッドとURI

GET

/v3/{project_id}/messages

HTTPステータスコード

正常時：200

エラー時：400

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

名前	In	Type	デフォルト値 /必須指定	Description
project_id	path	string	必須	プロジェクトのUUID
sort	query	string	任意	ソートキーと任意のソート指示のリスト 以下の形式で、コンマ(,)で区切られます。 < キー > [: < 方向 > ] 方向は、「asc(昇順)」または「desc(降順)」のどちらかです。
limit	query	integer	任意	クエリ結果で返却される項目の最大数 指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
offset	query	string	任意	limitと組み合わせて、項目の一部分を表示させます。offsetは表示するリストの開始位置です。
marker	query	string	任意	前回のレスポンスの最後の項目のID limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。

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

名前	Type	Description
messages	array	メッセージオブジェクトのリスト
request_id	string	メッセージが作成されたきっかけとなったリクエストID
links	array	メッセージへのリンクURL
message_level	string	メッセージのレベル
event_id	string	メッセージに該当するイベントのID
created_at	string	リソースの作成日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例：2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。
guaranteed_until	string	メッセージの有効期限 有効期限が過ぎると、メッセージが削除される可能性があります。
resource_uuid	string	メッセージが作成されたイベントに利用されたリソースのUUID
id	integer	メッセージのID
resource_type	string	resource_uuidのリソースのタイプ
user_message	string	event_idに該当するメッセージのテキスト

レスポンス例

{
    "messages": [{
        "request_id": "req-c1216709-afba-4703-a1a3-22eda88f2f5a",
        "links": [
            {
                "href": "http://localhost:8776/v3/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
                "rel": "self"
            },
            {
                "href": "http://localhost:8776/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
                "rel": "bookmark"
            }
        ],
        "message_level": "ERROR",
        "event_id": "VOLUME_000002",
        "created_at": "2014-10-28T00:00:00-00:00",
        "guaranteed_until": "2014-10-28T00:00:00-00:00",
        "resource_uuid": "d5f6c517-c3e8-45fe-b994-b11118e4cacf",
        "id": "c506cd4b-9048-43bc-97ef-0d7dec369b42",
        "resource_type": "VOLUME",
        "user_message": "No storage could be allocated for this volume request."
    },{
        "request_id": "req-c1216709-afba-4703-a1a3-22eda88f2f5a",
        "links": [
            {
                "href": "http://localhost:8776/v3/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
                "rel": "self"
            },
            {
                "href": "http://localhost:8776/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
                "rel": "bookmark"
            }
        ],
        "message_level": "ERROR",
        "event_id": "VOLUME_000002",
        "created_at": "2014-10-28T00:00:00-00:00",
        "guaranteed_until": "2014-10-28T00:00:00-00:00",
        "resource_uuid": "d5f6c517-c3e8-45fe-b994-b11118e4df4e",
        "id": "c506cd4b-9048-43bc-97ef-0d7dec36d5gt",
        "resource_type": "VOLUME",
        "user_message": "No storage could be allocated for this volume request."
    }]
}