Flavor operations#

This section covers the following flavor operations:

Flavors Operations

List flavors
List flavors with details
Show flavor details

Extra Spec Operation

Show flavor with extra specs

OS Extra Spec Operations

List flavor with OS extra specs
Show flavor details with OS extra specs

Retrieve list of flavors#

GET /flavors

This operation retrieves a list of IDs, names, and links for all available flavors.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200 203	Success	Request succeeded.
400	Error	A general error has occured.
401	Unauthorized	Unauthorized.
403	Forbidden	Forbidden.
405	Bad Method	Bad method.
409	Conflicting Reqest	Conflicting request.
413	Over Limit	The number of items returned is above the allowed limit.
500	API Fault	API fault.
503	Service Unavailable	The requested service is unavailable.

Request#

This table shows the query parameters for the request:

Name	Type	Description
minDisk	Int	Filters the list of flavors to those with the specified minimum number of gigabytes of disk storage.
minRam	Int	Filters the list of flavors to those with the specified minimum amount of RAM in megabytes.
marker	String	The ID of the last item in the previous list.
limit	Int	Sets the page size.

This operation does not accept a request body.

Example Retrieve list of flavors: JSON request

X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
Content-Type: application/json
Accept: application/json

Response#

This table shows the body parameters for the response:

Name	Type	Description
flavors	Array	The array of flavors.
flavors.id	String	The flavor ID.
flavors.links	String	The array of flavor links for self and bookmark.
flavors.links.href	Uuid	The URL for the flavor and the associated `rel`.
flavors.links.rel	Uuid	The descriptive field for the associated `href`, which is either `self` or `bookmark`.
flavors.name	String	The flavor name.

Example Retrieve list of flavors: JSON response

The following example shows only a few flavors in the list for brevity.

Status Code: 200 OK
Content-Length: 9132
Content-Type: application/json
Date: Wed, 08 Jul 2015 21:33:49 GMT, Wed, 08 Jul 2015 21:33:49 GMT
Server: Jetty(9.2.z-SNAPSHOT)
Via: 1.1 Repose (Repose/6.2.1.2)
X-Compute-Request-Id: req-dbb15502-9620-450b-a05e-63e291595a89

{
    "flavors": [
        {
            "id": "2",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "512MB Standard Instance"
        },
        {
            "id": "3",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "1GB Standard Instance"
        },
        {
            "id": "4",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "2GB Standard Instance"
        },
        {
            "id": "5",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "4GB Standard Instance"
        },
        {
            "id": "6",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/6",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/6",
                    "rel": "bookmark"
                }
            ],
            "name": "8GB Standard Instance"
        },
        {
            "id": "7",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/7",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/7",
                    "rel": "bookmark"
                }
            ],
            "name": "15GB Standard Instance"
        },
        {
            "id": "8",
            "links": [
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/v2/453265/flavors/8",
                    "rel": "self"
                },
                {
                    "href": "https://dfw.servers.api.rackspacecloud.com/453265/flavors/8",
                    "rel": "bookmark"
                }
            ],
            "name": "30GB Standard Instance"
        }
    ]
}

Retrieve list of flavors with details#

GET /flavors/detail

This operation returns details of all flavors in the response body.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	Success	Request succeeded.
400	Error	A general error has occured.
401	Unauthorized	Unauthorized.
403	Forbidden	Forbidden.
405	Bad Method	Bad method.
409	Conflicting Reqest	Conflicting request.
413	Over Limit	The number of items returned is above the allowed limit.
500	API Fault	API fault.
503	Service Unavailable	The requested service is unavailable.

Request#

This table shows the query parameters for the request:

Name	Type	Description
minDisk	Int	Filters the list of flavors to those with the specified minimum number of gigabytes of disk storage.
minRam	Int	Filters the list of flavors to those with the specified minimum amount of RAM in megabytes.
marker	String	The ID of the last item in the previous list.
limit	Int	Sets the page size.

This operation does not accept a request body.

Example Retrieve list of flavors with details: JSON request

X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
Content-Type: application/json
Accept: application/json

Response#

This table shows the body parameters for the response:

Name	Type	Description
flavor	Array	The container of flavor attributes.
flavors.OS- FLV-WITH-EXT- SPECS:extra_specs	String	The container of flavor extra specifications.
flavors.OS-FLV-WITH-EXT- SPECS:extra_specs.class	String	The class for the flavor.
flavors.OS-FLV-WITH-EXT- SPECS:extra_specs.policy_class	String	The policy class for the flavor.
flavors.OS-FLV-WITH-EXT- SPECS:extra_specs.disk_io_index	String	The io index for the disk.
flavors.OS-FLV-WITH-EXT- SPECS:extra_specs.number_of_data_disks	String	The policy class for the flavor.
flavors.name	String	The flavor name.
flavors.links	String	The array of flavor links for self and bookmark.
flavors.links.href	Uuid	The URL for the flavor and the associated `rel`.
flavors.links.rel	Uuid	The descriptive field for the associated `href`, which is either `self` or `bookmark`.
flavors.ram	String	The amount of RAM.
flavors.vcpus	String	The number of virtual CPUs.
flavors.swap	String	The amount of swap space
flavors.rxtx-factor	String	The rxtx factor, which describes configured bandwidth cap values.
flavors.OS- FLV-EXT-DATA:ephemeral	String	The number of ephemeral disks.
flavors.disk	String	The disk size.
flavors.id	String	The flavor id.

Example Retrieve list of flavors with details: JSON response

The following example shows only a few images in the list for brevity.

Status Code: 200 OK
Content-Length: 18360
Content-Type: application/json
Date: Fri, 10 Jul 2015 18:27:40 GMT, Fri, 10 Jul 2015 18:27:40 GMT
Server: Jetty(9.2.z-SNAPSHOT)
Via: 1.1 Repose (Repose/6.2.1.2)
X-Compute-Request-Id: req-63cec0f7-a82d-426c-91ce-296bb66d7f74

{
  "flavors": [
      {
      "OS-FLV-WITH-EXT-SPECS:extra_specs": {
        "resize_policy_class": "performance_flavor",
        "policy_class": "performance_flavor",
        "class": "performance2",
        "disk_io_index": "60",
        "number_of_data_disks": "2"
      },
      "name": "60 GB Performance",
      "links": [
        {
          "href": "https://dfw.servers.api.rackspacecloud.com/v2/820712/flavors/performance2-60",
          "rel": "self"
        },
        {
          "href": "https://dfw.servers.api.rackspacecloud.com/820712/flavors/performance2-60",
          "rel": "bookmark"
        }
      ],
      "ram": 61440,
      "vcpus": 16,
      "swap": "",
      "rxtx_factor": 5000,
      "OS-FLV-EXT-DATA:ephemeral": 600,
      "disk": 40,
      "id": "performance2-60"
    },
      {
      "OS-FLV-WITH-EXT-SPECS:extra_specs": {
        "resize_policy_class": "performance_flavor",
        "policy_class": "performance_flavor",
        "class": "performance2",
        "disk_io_index": "70",
        "number_of_data_disks": "3"
      },
      "name": "90 GB Performance",
      "links": [
        {
          "href": "https://dfw.servers.api.rackspacecloud.com/v2/820712/flavors/performance2-90",
          "rel": "self"
        },
        {
          "href": "https://dfw.servers.api.rackspacecloud.com/820712/flavors/performance2-90",
          "rel": "bookmark"
        }
      ],
      "ram": 92160,
      "vcpus": 24,
      "swap": "",
      "rxtx_factor": 7500,
      "OS-FLV-EXT-DATA:ephemeral": 900,
      "disk": 40,
      "id": "performance2-90"
    }
  ]
}

Retrieve flavor details#

GET /flavors/{flavor_id}

This operation returns details of the specified flavor in the response body.

Specify the flavor ID in the URI.

The following extensions provide additional information when viewing flavor details:

Flavor with extra specs
Flavor extra specs

This table shows the possible response codes for this operation:

Response Code	Name	Description
200 203	Success	Request succeeded.
400	Error	A general error has occured.
401	Unauthorized	Unauthorized.
403	Forbidden	Forbidden.
405	Bad Method	Bad method.
409	Conflicting Reqest	Conflicting request.
413	Over Limit	The number of items returned is above the allowed limit.
500	API Fault	API fault.
503	Service Unavailable	The requested service is unavailable.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{flavor_id}	Uuid	The UUID for the flavor.

This operation does not accept a request body.

Example Retrieve flavor details: JSON request

X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
Content-Type: application/json
Accept: application/json

Response#

This table shows the body parameters for the response:

Name	Type	Description
flavor	Object	The container of flavor attributes.
flavor.OS-FLV-WITH-EXT- SPECS:extra_specs	String	The container of flavor extra specifications.
flavor.OS-FLV-WITH-EXT- SPECS:extra_specs.class	String	The class for the flavor.
flavor.OS-FLV-WITH-EXT- SPECS:extra_specs.policy_class	String	The policy class for the flavor.
flavor.OS-FLV-WITH-EXT- SPECS:extra_specs.disk_io_index	String	The io index for the disk.
flavor.OS-FLV-WITH-EXT- SPECS:extra_specs.number_of_data_disks	String	The policy class for the flavor.
flavor.name	String	The flavor name.
flavor.links	String	The array of flavor links for self and bookmark.
flavor.links.href	Uuid	The URL for the flavor and the associated `rel`.
flavor.links.rel	Uuid	The descriptive field for the associated `href`, which is either `self` or `bookmark`.
flavor.ram	String	The amount of RAM.
flavor.vcpus	String	The number of virtual CPUs.
flavor.swap	String	The amount of swap space
flavor.rxtx-factor	String	The rxtx factor, which describes configured bandwidth cap values.
flavor.OS- FLV-EXT-DATA:ephemeral	String	The number of ephemeral disks.
flavor.disk	String	The disk size.
flavor.id	String	The flavor id.

Example Retrieve flavor details: JSON response

Status Code: 200 OK
Content-Length: 528
Content-Type: application/json
Date: Wed, 08 Jul 2015 21:38:05 GMT, Wed, 08 Jul 2015 21:38:06 GMT
Server: Jetty(9.2.z-SNAPSHOT)
Via: 1.1 Repose (Repose/6.2.1.2)
X-Compute-Request-Id: req-3c0027db-484f-4f36-81b7-0b35b556bc78

{
    "flavor": {
        "OS-FLV-EXT-DATA:ephemeral": 0,
        "OS-FLV-WITH-EXT-SPECS:extra_specs": {
            "class": "compute1",
            "disk_io_index": "-1",
            "number_of_data_disks": "0",
            "policy_class": "compute_flavor"
        },
        "disk": 0,
        "id": "compute1-15",
        "links": [
            {
                "href": "https://dfw.servers.api.rackspacecloud.com/v2/820712/flavors/compute1-15",
                "rel": "self"
            },
            {
                "href": "https://dfw.servers.api.rackspacecloud.com/820712/flavors/compute1-15",
                "rel": "bookmark"
            }
        ],
        "name": "15 GB Compute v1",
        "ram": 15360,
        "rxtx_factor": 1250.0,
        "swap": "",
        "vcpus": 8
    }
}

Show flavor with extra specs#

GET /flavors/{flavor_id}

This operation shows extra specifications for the flavor, such as identifying the policy class, in the flavor operations.

In the URI, specify the flavor ID.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200 203	Success	Request succeeded.
400	Error	A general error has occured.
401	Unauthorized	Unauthorized.
403	Forbidden	Forbidden.
405	Bad Method	Bad method.
409	Conflicting Reqest	Conflicting request.
413	Over Limit	The number of items returned is above the allowed limit.
500	API Fault	API fault.
503	Service Unavailable	The requested service is unavailable.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{flavor_id}	String	The flavor id.

This operation does not accept a request body.

Example Show flavor with extra specs: JSON request

X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
Content-Type: application/json
Accept: application/json

Response#

This table shows the body parameters for the response:

Name	Type	Description
extra_specs	Object	The container for flavor extra specification details.
extra_specs.class	String	The class for the flavor.
extra_specs.policy_class	String	The policy class for the flavor.
extra_specs.disk_io_index	String	The io index for the disk.
extra_specs.number_of_data_disks	String	The policy class for the flavor.

Example Show flavor with extra specs: JSON response

Status Code: 200 OK
Content-Length: 124
Content-Type: application/json
Date: Tue, 27 Jan 2015 13:46:52 GMT
Server: Jetty(8.0.y.z-SNAPSHOT)
Via: 1.1 Repose (Repose/2.12)
x-compute-request-id: req-7c63f55b-9b16-49d2-854c-dfecfc362116

{
  "extra_specs": {
    "policy_class": "compute_flavor",
    "class": "compute1",
    "disk_io_index": "-1",
    "number_of_data_disks": "0"
  }
}

List extra specs for flavors#

GET /flavors/{flavor_id}/os-extra_specs

This operation shows extra specifications for flavors.

In the URI, specify the flavor ID.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200 203	Success	Request succeeded.
400	Error	A general error has occured.
401	Unauthorized	Unauthorized.
403	Forbidden	Forbidden.
405	Bad Method	Bad method.
409	Conflicting Reqest	Conflicting request.
413	Over Limit	The number of items returned is above the allowed limit.
500	API Fault	API fault.
503	Service Unavailable	The requested service is unavailable.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{flavor_id}	String	The flavor id.

This operation does not accept a request body.

Example List extra specs for flavors: JSON request

X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
Content-Type: application/json
Accept: application/json

Response#

This table shows the body parameters for the response:

Name	Type	Description
extra_specs	Object	The container for flavor extra specification details.
extra_specs.class	String	The class for the flavor.
extra_specs.policy_class	String	The policy class for the flavor.
extra_specs.disk_io_index	String	The io index for the disk.
extra_specs.number_of_data_disks	String	The policy class for the flavor.

Example List extra specs for flavors: JSON response

Status Code: 200 OK
Content-Length: 124
Content-Type: application/json
Date: Wed, 08 Jul 2015 15:58:25 GMT, Wed, 08 Jul 2015 15:58:25 GMT
Server: Jetty(9.2.z-SNAPSHOT)
Via: 1.1 Repose (Repose/6.2.1.2)
X-Compute-Request-Id: req-5b690cfe-c1c7-4749-b0b1-cedf92d378dc

{
  "extra_specs": {
    "policy_class": "general_flavor",
    "class": "general1",
    "disk_io_index": "40",
    "number_of_data_disks": "0"
  }
}

Get details for specified flavor extra spec#

GET /flavors/{flavor_id}/os-extra_specs/{key_id}

This operation shows extra specifications for flavors.

In the URI, specify the key ID, or name, of the flavor extra spec.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200 203	Success	Request succeeded.
400	Error	A general error has occured.
401	Unauthorized	Unauthorized.
403	Forbidden	Forbidden.
405	Bad Method	Bad method.
409	Conflicting Reqest	Conflicting request.
413	Over Limit	The number of items returned is above the allowed limit.
500	API Fault	API fault.
503	Service Unavailable	The requested service is unavailable.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{flavor_id}	String	The flavor id.
{key_id}	String	The flavor key.

This operation does not accept a request body.

Example Get details for specified flavor extra spec: JSON request

X-Auth-Token: f064c46a782c444cb4ba4b6434288f7c
Content-Type: application/json
Accept: application/json

Response#

This table shows the body parameters for the response:

Name	Type	Description
extra_specs	Object	The container for flavor extra specification details.
extra_specs.class	String	The class for the flavor.
extra_specs.policy_class	String	The policy class for the flavor.
extra_specs.disk_io_index	String	The io index for the disk.
extra_specs.number_of_data_disks	String	The policy class for the flavor.

Example Get details for specified flavor extra spec: JSON response

Status Code: 200 OK
Content-Length: 23
Content-Type: application/json
Date: Wed, 08 Jul 2015 16:03:05 GMT, Wed, 08 Jul 2015 16:03:06 GMT
Server: Jetty(9.2.z-SNAPSHOT)
Via: 1.1 Repose (Repose/6.2.1.2)
X-Compute-Request-Id: req-7d127037-39af-4459-9f90-26b750a5cb45

{
  "disk_io_index": "40"
}