List Flavors with Details#

フレーバーと詳細情報を一覧表示します。

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}/flavors/detail

HTTPステータスコード#

正常時:200

エラー時:400, 401, 403

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

名前 In Type デフォルト値
/必須指定
Description
project_id path string 必須 プロジェクトのUUID
sort_key query string flavorid
任意
フレーバーの属性でソートします。クエリパラメータに、複数のソートキーとソート方向を指定することができます。ソート方向を省略する場合は、sort_keyの属性のデフォルト方向が使われます。
sort_dir query string asc
任意
ソートの方向
asc (ascending:昇順)、またはdesc (descending:降順)です。クエリパラメータに、複数のソートキーとソート方向を指定することができます。ソート方向を省略する場合は、sort_keyの属性のデフォルト方向が使われます。
limit query integer 任意 クエリ結果で返却される項目の最大数
指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、フレーバーリストの続きを取得することができます。
marker query string 任意 前回のレスポンスの最後の項目のID
limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、フレーバーリストの続きを取得することができます。
minDisk query integer 任意 最低ディスクサイズでレスポンスを絞り込みます(GB単位)。
例: 100
minRam query integer 任意 最低RAMサイズでレスポンスを絞り込みます(MB単位)。
例: 512

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

名前 Type Description
flavors array フレーバーのオブジェクトの配列
name string フレーバーの表示名
description string フレーバーの説明
📒注: 表示するにはマイクロバージョン2.55以上を指定してください。
id string フレーバーのID
ram integer フレーバーのRAMの量(MB単位)
disk integer 作成するシステムディスクのサイズ(GB単位)
0の場合は、配置するために使われるイメージのサイズに設定されます。
vcpus integer サーバに割り当てる仮想CPUの数
links array 表示されているリソースへのリンクURL
OS-FLV-EXT-DATA:ephemeral integer 作成する揮発性のディスクのサイズ(GB単位)
デフォルトは0です。
OS-FLV-DISABLED:disabled boolean フレーバーの管理状態は無効になっているかどうかを表示します。通常は、管理者ユーザーだけが見えます。
swap integer スワップディスクとして使われるディスクサイズ(MB単位)
デフォルトは0で、その場合はスワップディスクが作成されません。現在は空文字列「"」で0を表現します。
rxtx_factor float バックエンドネットワークはQoS拡張をサポートしている場合に使われる、送受信時にポートに適用される(不動の)係数
QoSが無効な場合は無視されます。デフォルトは1.0です。
os-flavor-access:is_public boolean フレーバーが全プロジェクトに公開している、それとも特定したプロジェクトだけの間に公開しているかを表示します。デフォルトは「true」です。

レスポンス例#

{
    "flavors": [
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 1,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "ram": 512,
            "swap": "",
            "vcpus": 1,
            "rxtx_factor": 1.0,
            "description": null
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 20,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "2",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "ram": 2048,
            "swap": "",
            "vcpus": 1,
            "rxtx_factor": 1.0,
            "description": null
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 40,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "3",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "ram": 4096,
            "swap": "",
            "vcpus": 2,
            "rxtx_factor": 1.0,
            "description": null
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 80,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "4",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "ram": 8192,
            "swap": "",
            "vcpus": 4,
            "rxtx_factor": 1.0,
            "description": null
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 160,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "5",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.xlarge",
            "ram": 16384,
            "swap": "",
            "vcpus": 8,
            "rxtx_factor": 1.0,
            "description": null
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 1,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "6",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/6",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/6",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny.specs",
            "ram": 512,
            "swap": "",
            "vcpus": 1,
            "rxtx_factor": 1.0,
            "description": null
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 20,
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "os-flavor-access:is_public": true,
            "id": "7",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/7",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/7",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small.description",
            "ram": 2048,
            "swap": "",
            "vcpus": 1,
            "rxtx_factor": 1.0,
            "description": "test description"
        }
    ]
}