List attachments#

アタッチメントを一覧表示します。

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

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}/attachments

HTTPステータスコード#

正常時：200

エラー時：400

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

名前 In Type デフォルト値
/必須指定		 Description
project_id path string 必須 プロジェクトのUUID
limit query integer 任意 クエリ結果で返却される項目の最大数
指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。

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

| |offset|query|integer|任意|limitと組み合わせて、項目の一部分を表示させます。offsetは表示するリストの開始位置です。| |sort|query|string|任意|ソートキーと任意のソート指示のリスト
以下の形式で、コンマ(,)で区切られます。

|

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

名前 Type Description
id string アタッチメントのID
instance string アタッチする仮想サーバのUUID
status string アタッチメントのステータス
volume_id string アタッチメントが所属するボリュームのUUID

レスポンス例#

{
  "attachments": [
    {
      "status": "attaching",
      "instance": "31c79baf-b59e-469c-979f-1df4ecb6eea7",
      "id": "3b8b6631-1cf7-4fd7-9afb-c01e541a073c",
      "volume_id": "462dcc2d-130d-4654-8db1-da0df2da6a0d"
    }
  ]
}

親トピック:API詳細(Attachments)