List Volume Types#

ボリュームタイプを一覧表示します。

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

HTTPステータスコード#

正常時:200

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

名前 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
volume_types array ボリュームタイプのリスト
name string ボリュームタイプ名
extra_specs object ボリュームタイプの仕様を示すキーと値のペア
os-volume-type-access:is_public boolean ボリュームタイプが全プロジェクトに公開しているか、それとも特定したプロジェクトだけの間に公開しているかを表示します。デフォルトは「true」です。
is_public boolean ボリュームタイプの公開状況
id string ボリュームタイプのID
description string ボリュームタイプの説明

レスポンス例#

{
    "volume_types": [
        {
            "name": "SSD",
            "qos_specs_id": null,
            "extra_specs": {
                "volume_backend_name": "lvmdriver-1"
            },
            "os-volume-type-access:is_public": true,
            "is_public": true,
            "id": "6685584b-1eac-4da6-b5c3-555430cf68ff",
            "description": null
        },
        {
            "name": "SATA",
            "qos_specs_id": null,
            "extra_specs": {
                "volume_backend_name": "lvmdriver-1"
            },
            "os-volume-type-access:is_public": true,
            "is_public": true,
            "id": "8eb69a46-df97-4e41-9586-9a40a7533803",
            "description": null
        }
    ]
}