List accessible volumes#

利用可能なボリュームを表示します。

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

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 integer 任意 limitと組み合わせて、項目の一部分を表示させます。offsetは表示するリストの開始位置です。
marker query string 任意 前回のレスポンスの最後の項目のID
limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
with_count query boolean false
任意
レスポンスにある項目の数を表示するかどうかを設定します。

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

名前 Type Description
volumes array volumeオブジェクトのリスト
id string ボリュームのUUID
links array ボリュームトランスファーのためのリンクURL
name string ボリュームの名前
count integer ページに分割される前の、リクエストされるリソースの総数
📒注: 表示するにはマイクロバージョン3.45以上を指定してください。

レスポンス例#

{
    "volumes": [
        {
            "id": "45baf976-c20a-4894-a7c3-c94b7376bf55",
            "links": [
                {
                    "href": "http://localhost:8776/v3/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
                    "rel": "bookmark"
                }
            ],
            "name": "vol-004"
        },
        {
            "id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
            "links": [
                {
                    "href": "http://localhost:8776/v3/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
                    "rel": "bookmark"
                }
            ],
            "name": "vol-003"
        }
    ],
    "count": 10
}