This page lists the Compute API v2.1 operations in the following order:
Effective in the OpenStack Kilo release, XML support in requests and responses was removed for the Compute API v2.1.
Lists information for all API versions.
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"versions": [
{
"id": "v2.0",
"links": [
{
"href": "http://openstack.example.com/v2/",
"rel": "self"
}
],
"status": "SUPPORTED",
"version": "",
"min_version": "",
"updated": "2011-01-21T11:33:21Z"
},
{
"id": "v2.1",
"links": [
{
"href": "http://openstack.example.com/v2.1/",
"rel": "self"
}
],
"status": "CURRENT",
"version": "2.3",
"min_version": "2.1",
"updated": "2013-07-23T11:33:21Z"
}
]
}
This operation does not accept a request body.
Creates one or more servers with an optional reservation ID. The request and response examples show how to create multiple servers with or without a reservation ID.
Creates one or more servers with an optional reservation ID.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"server": {
"name": "new-server-test",
"imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"flavorRef": "http://openstack.example.com/openstack/flavors/1",
"metadata": {
"My Server Name": "Apache1"
},
"min_count": "2",
"max_count": "3"
}
}
{
"server": {
"name": "new-server-test",
"imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"flavorRef": "http://openstack.example.com/openstack/flavors/1",
"metadata": {
"My Server Name": "Apache1"
},
"return_reservation_id": "True",
"min_count": "2",
"max_count": "3"
}
}
{
"server": {
"adminPass": "wfksH3GTTseP",
"id": "440cf918-3ee0-4143-b289-f63e1d2000e6",
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/440cf918-3ee0-4143-b289-f63e1d2000e6",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/440cf918-3ee0-4143-b289-f63e1d2000e6",
"rel": "bookmark"
}
]
}
}
{
"reservation_id": "r-3fhpjulh"
}
Performs actions on a server. Specify the action in the request body.
Reboots the specified server. Specify the reboot
action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"reboot": {
"type": "HARD"
}
}
This operation does not return a response body.
Rebuilds the specified server. Specify the
rebuild action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"rebuild": {
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"imageRef": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"name": "foobar",
"adminPass": "seekr3t",
"metadata": {
"meta_var": "meta_val"
}
}
}
{
"server": {
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"version": 4
}
]
},
"adminPass": "seekr3t",
"created": "2013-11-14T06:29:00Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "28d8d56f0e3a77e20891f455721cbb68032e017045e20aa5dfc6cb66",
"id": "a0a80a94-3d81-4a10-822a-daa0cf9e870b",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/a0a80a94-3d81-4a10-822a-daa0cf9e870b",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/a0a80a94-3d81-4a10-822a-daa0cf9e870b",
"rel": "bookmark"
}
],
"metadata": {
"meta_var": "meta_val"
},
"name": "foobar",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-11-14T06:29:02Z",
"user_id": "fake"
}
}
Rebuilds the specified server with preserve ephemeral option. Specify the
rebuild action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"rebuild": {
"imageRef": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"name": "foobar",
"adminPass": "seekr3t",
"metadata": {
"meta_var": "meta_val"
},
"personality": [
{
"path": "/etc/banner.txt",
"contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
}
],
"preserve_ephemeral": true
}
}
{
"server": {
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"version": 4
}
]
},
"adminPass": "seekr3t",
"created": "2013-11-14T06:29:00Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "28d8d56f0e3a77e20891f455721cbb68032e017045e20aa5dfc6cb66",
"id": "a0a80a94-3d81-4a10-822a-daa0cf9e870b",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/a0a80a94-3d81-4a10-822a-daa0cf9e870b",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/a0a80a94-3d81-4a10-822a-daa0cf9e870b",
"rel": "bookmark"
}
],
"metadata": {
"meta_var": "meta_val"
},
"name": "foobar",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-11-14T06:29:02Z",
"user_id": "fake"
}
}
Resizes the specified server. Specify the resize
action in the request body.
A successfully resized server shows a status of
VERIFY_RESIZE, a vm_status of
RESIZED, and a migration_status of
finished. If you set the auto_confirm option of
the Compute service to True, the Compute service
automatically confirms the resize operation.
Preconditions
You can only resize a server when its status is
ACTIVE or SHUTOFF.
If the specified server is locked, you must have administrator privileges to resize the server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"resize": {
"flavorRef": "2"
}
}
This operation does not return a response body.
Confirms a pending resize action. Specify the
confirmResize action in the request body.
After you make this request, you typically must keep
polling the server status to determine whether the request
succeeded. A successfully confirming resize operation shows
a status of ACTIVE or SHUTOFF and
a migration_status of confirmed. You can also
see the resized server in the compute node that OpenStack
Compute manages.
Preconditions
You can only confirm the resized server where the status
is VERIFY_RESIZED, the vm_status is RESIZED,
and the migration_status is finished or
confirming.
If the specified server is locked, you must have administrator privileges to confirm the server.
Troubleshooting
If the specified server status remains
RESIZED, the request failed. Ensure you meet the
preconditions and run the request again. If the request fails again,
investigate the compute back end or ask your cloud provider.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"confirmResize": null
}
This operation does not return a response body.
Cancels and reverts a pending resize action. Specify the
revertResize action in the request body.
After you make this request, you typically must keep
polling the server status to determine whether the request
succeeded. A successfully reverting resize operation shows
a status of ACTIVE or SHUTOFF
and a migration_status of reverted. You can
also see the reverted server in the compute node that
OpenStack Compute manages.
Preconditions
You can only confirm the resized server where the status
is VERIFY_RESIZE and the vm_status is RESIZED.
If the specified server is locked, you must have administrator privileges to revert the resizing.
Troubleshooting
If the specified server status remains
RESIZED, the request failed. Ensure you meet the
preconditions and run the request again. If the request fails again,
investigate the compute back end.
The specified server is not reverted in the compute node that OpenStack Compute manages.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"revertResize": null
}
This operation does not return a response body.
Creates an image. Specify the createImage
action in the request body.
After you make this request, you typically must keep polling the status of the created image to determine whether the request succeeded.
If the operation succeeds, the created image has a status of
available and the server status returns to the
original status. You can also see the new image in the image
back end that OpenStack Image service manages.
Preconditions
The specified server must exist.
You can only create a new image from the server
when its status is ACTIVE, SHUTOFF,
PAUSED, or SUSPENDED.
The connection to the Image service is valid.
Troubleshooting
If the image status remains uploading or shows another error status, the request failed. Ensure you meet the preconditions and run the request again. If the request fails again, investigate the image back end.
If the server status does not go back to an original server's status, the request failed. Ensure you meet the preconditions, or check if there is another operation that causes race conditions for the server, then run the request again. If the request fails again, investigate the compute back end or ask your cloud provider.
If the request fails due to an error on OpenStack Compute service, the image is purged from the image store that OpenStack Image service manages. Ensure you meet the preconditions and run the request again. If the request fails again, investigate OpenStack Compute service or ask your cloud provider.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"createImage": {
"name": "foo-image",
"metadata": {
"meta_var": "meta_val"
}
}
}
This operation does not return a response body.
Starts a stopped server and changes
its status to ACTIVE.
Preconditions
The server status must be SHUTOFF.
If the specified server is locked, you must have administrator privileges to start the server.
Asynchronous Postconditions
After you successfully start a server,
its status changes to ACTIVE. The server appears on the compute
node that the Compute service manages.
Troubleshooting
If the server status does not change
to ACTIVE, the start operation failed. Ensure
that you meet the preconditions and run the request again.
If the request fails again, investigate whether another
operation is running that causes a race condition.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| os-start | plain | xsd:string |
Specify the
|
{
"os-start": null
}
This operation does not return a response body.
Stops a running server and changes
its status to SHUTOFF.
Preconditions
The server status must be
ACTIVE or ERROR.
If the specified server is locked, you must have administrator privileges to stop the server.
Asynchronous Postconditions
After you successfully stop a server,
its status changes to SHUTOFF. The server instance data appears
only on the compute node that Compute service manages.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| os-stop | plain | xsd:string |
Specify the
|
{
"os-stop": null
}
This operation does not return a response body.
Attaches a specified volume. Specify the attach
action in the request body.
If the attach operation succeeds, the volume status
is in-use.
Preconditions
The specified server must exist.
You can only attach a volume to the server
when its status is available.
The connection to the Block storage service is valid.
Troubleshooting
If the request fails due to an OpenStack Compute service error, ensure you meet the preconditions and run the request again. If the request fails again, investigate OpenStack Compute service or ask your cloud provider.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| volume_id | plain | csapi:UUID |
The volume ID. |
| device (Optional) | plain | xsd:string |
The device name. |
| disk_bus (Optional) | plain | xsd:string |
The disk bus name. |
| device_type (Optional) | plain | xsd:string |
The device type name. |
{
"attach": {
"volume_id": "15e59938-07d5-11e1-90e3-e3dffe0c5983",
"device": "/dev/vdb",
"disk_bus": "ide",
"device_type": "cdrom"
}
}
This operation does not return a response body.
Puts a server in rescue mode and changes its status to
RESCUE.
If you specify the rescue_image_ref extended
attribute, the specified image is used to rescue the instance.
If you omit an image reference, the base image reference is
used by default.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| rescue | plain | xsd:string |
Specify the |
| adminPass (Optional) | plain | csapi:string |
The password for the rescued instance. If you omit this parameter, the operation generates a new password. |
| rescue_image_ref (Optional) | plain | csapi:string |
The image reference to use to rescue your server instance. Specify the image reference by ID or full URL. If you omit an image reference, default is the base image reference. |
{
"rescue": {
"adminPass": "MySecretPass",
"rescue_image_ref": "70a599e0-31e7-49b7-b260-868f441e862b"
}
}
{
"server": {
"accessIPv4": "",
"accessIPv6": "",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"version": 4
}
]
},
"created": "2012-09-19T09:22:27Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "c02c15d17499304e9893d9fc41c415f5096f8aa880bc651cac092650",
"id": "7e21a264-6cc1-4d90-b7b5-f9f49cec3a85",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/7e21a264-6cc1-4d90-b7b5-f9f49cec3a85",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/7e21a264-6cc1-4d90-b7b5-f9f49cec3a85",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"status": "RESCUE",
"tenant_id": "openstack",
"updated": "2012-09-19T09:22:27Z",
"user_id": "fake"
}
}
Permits all users to list available server actions for a specified server. Permits administrators to get details for a specified server action for a specified server.
Lists actions for a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"serverActions": [
{
"action": "resize",
"server_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
"message": "",
"project_id": "842",
"request_id": "req-25517360-b757-47d3-be45-0e8d2a01b36a",
"start_time": "2012-12-05T01:00:00.000000",
"user_id": "789"
},
{
"action": "reboot",
"server_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
"message": "",
"project_id": "147",
"request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
"start_time": "2012-12-05T00:00:00.000000",
"user_id": "789"
}
]
}
This operation does not accept a request body.
Shows details for a specified action and specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"serverAction": {
"action": "reboot",
"events": [
{
"event": "schedule",
"finish_time": "2012-12-05T01:02:00.000000",
"result": "Success",
"start_time": "2012-12-05T01:00:02.000000",
"traceback": ""
},
{
"event": "compute_create",
"finish_time": "2012-12-05T01:04:00.000000",
"result": "Success",
"start_time": "2012-12-05T01:03:00.000000",
"traceback": ""
}
],
"server_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
"message": "",
"project_id": "147",
"request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
"start_time": "2012-12-05T00:00:00.000000",
"user_id": "789"
}
}
This operation does not accept a request body.
Administrators only. Performs actions on a server. Specify the action in the request body.
Changes the admin password.
Specify the changePassword action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"changePassword": {
"adminPass": "foo"
}
}
This operation does not return a response body.
Specify the createBackup action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"createBackup": {
"name": "Backup 1",
"backup_type": "daily",
"rotation": 1
}
}
This operation does not return a response body.
Injects network information into a server.
Specify the injectNetworkInfo action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"injectNetworkInfo": null
}
This operation does not return a response body.
Live-migrates a server to a new host without rebooting.
Specify the os-migrateLive action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"os-migrateLive": {
"host": "01c0cadef72d47e28a672a76060d492c",
"block_migration": false,
"disk_over_commit": false
}
}
This operation does not return a response body.
Specify the lock action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"lock": null
}
This operation does not return a response body.
Migrates a server to a host. The scheduler chooses the host.
Specify the migrate action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"migrate": null
}
This operation does not return a response body.
Pauses a server. Changes its status to PAUSED.
Specify the pause action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"pause": null
}
This operation does not return a response body.
Resets networking on a server.
Specify the resetNetwork action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"resetNetwork": null
}
This operation does not return a response body.
Resets the state of a server to a specified state.
Specify the os-resetState action and the
state in the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"os-resetState": {
"state": "active"
}
}
This operation does not return a response body.
Resumes a SUSPENDED server and changes its status to ACTIVE.
Specify the resume action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"resume": null
}
This operation does not return a response body.
Suspends a server and changes its status to SUSPENDED.
Specify the suspend action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"suspend": null
}
This operation does not return a response body.
Specify the unlock action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"unlock": null
}
This operation does not return a response body.
Unpauses a PAUSED server and changes its status to ACTIVE.
Specify the unpause action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"unpause": null
}
This operation does not return a response body.
Enables users with the administrative role or the owner of the server to change the password of the administrative user.
Changes the admin password.
Specify the changePassword action in
the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"changePassword": {
"adminPass": "foo"
}
}
This operation does not return a response body.
Gets console output for a server instance.
Gets console output for a server instance.
Specify the os-getConsoleOutput action in the
request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| os-getConsoleOutput | plain | xsd:string |
Specify the |
| length (Optional) | plain | String |
Number of lines to fetch from the end of
console log. |
{
"os-getConsoleOutput": {
"length": 50
}
}
{
"output": "FAKE CONSOLE OUTPUT\nANOTHER\nLAST LINE"
}
Adds or removes fixed IP addresses from an instance.
Removes an IP from a specified instance.
Specify the remove_fixed_ip action in the request
body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"removeFixedIp": {
"address": "10.0.0.4"
}
}
This operation does not return a response body.
Adds an IP to a specified network on an instance.
Specify the addFixedIp action in the request
body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"addFixedIp": {
"networkId": 1
}
}
This operation does not return a response body.
Provides interactive console support.
Specify the get_spice_console action in the request
body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"os-getSPICEConsole": {
"type": "spice-html5"
}
}
{
"console": {
"type": "spice-html5",
"url": "http://127.0.0.1:6082/spice_auto.html?token=a30e5d08-6a20-4043-958f-0852440c6af4"
}
}
Gets text console output for VNC.
Specify the get_vnc_console action in the request
body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"os-getVNCConsole": {
"type": "novnc"
}
}
{
"console": {
"type": "novnc",
"url": "http://127.0.0.1:6080/vnc_auto.html?token=191996c3-7b0f-42f3-95a7-f1839f2da6ed"
}
}
Shelves running servers, restores shelved servers, and removes shelved servers.
Shelving is useful when you have an unused instance that you would like to keep for later use. For example, at the end of a work week you can shelve an instance and at the start of the next week you can unshelve it.
Your cloud provider might bill you for a shelved server.
Use the shelve action to shelve a server. All
associated data and resources are kept but anything still in memory
is not retained.
Use the unshelve action to restore a shelved instance.
Use the shelveOffload action to remove a shelved
instance that you no longer need.
Specify the shelve action in the request
body.
All associated data and resources are kept but anything still in
memory is not retained. To restore a shelved instance, use the
unshelve action. To remove a shelved instance, use
the shelveOffload action.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
Preconditions
The server status must be ACTIVE,
SHUTOFF, PAUSED, or
SUSPENDED.
If the specified server is locked, you must have administrator privileges to shelve the server.
Asynchronous Postconditions
After you successfully shelve a server, its status changes
to SHELVED and the image status is
ACTIVE. The server instance data appears on
the compute node that the Compute service manages.
If you boot the server from volumes or set the
shelved_offload_time option to 0, the Compute
service automatically deletes the instance on compute
nodes and changes the server status to
SHELVED_OFFLOADED.
Troubleshooting
If the server status does not change to
SHELVED or SHELVED_OFFLOADED,
the shelve operation failed. Ensure that you meet the
preconditions and run the request again. If the request
fails again, investigate whether another operation is
running that causes a race condition.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| shelve | plain | xsd:string |
Specify the |
{
"shelve": null
}
This operation does not return a response body.
Restores a shelved server.
Specify the unshelve action in the request
body.
Policy defaults enable only users with the administrative
role or the owner of the server to perform this
operation. Cloud providers can change these permissions through the
policy.json file.
Preconditions
The server status must be
SHELVED or SHELVED_OFFLOADED.
If the specified server is locked, you must have administrator privileges to unshelve the server.
Asynchronous Postconditions
After you successfully shelve a server, its
status changes to ACTIVE. The server appears on
the compute node.
The shelved image is deleted from the list of images returned by an API call.
Troubleshooting
If the server status does not change to
ACTIVE, the unshelve operation failed. Ensure
that you meet the preconditions and run the request again.
If the request fails again, investigate whether another
operation is running that causes a race condition.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| unshelve | plain | xsd:string |
Specify the |
{
"unshelve": null
}
This operation does not return a response body.
Removes an instance from the server.
Specify the shelveOffload action in the request
body.
Data and resource associations are deleted. If an instance is no longer needed, you can remove that instance from the hypervisor to minimize resource usage.
Policy defaults enable only users with the administrative
role or the owner of the server to perform this
operation. Cloud providers can change these permissions through the
policy.json file.
Preconditions
The server status must be
SHELVED.
If the specified server is locked, you must have administrator privileges to shelve-offload the server.
Asynchronous Postconditions
After you successfully shelve-offload a
server, its status changes to SHELVED_OFFLOAD.
The server instance data appears on the compute
node.
Troubleshooting
If the server status does not change
to SHELVEDED_OFFLOADED, the shelve-offload
operation failed. Ensure that you meet the preconditions
and run the request again. If the request fails again,
investigate whether another operation is running that
causes a race condition.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| shelveOffload | plain | xsd:string |
Specify the |
{
"shelveOffload": null
}
This operation does not return a response body.
Force-deletes a server or restores a soft-deleted server.
Force deletes an instance before deferred cleanup.
Specify the forceDelete action in the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"forceDelete": null
}
This operation does not return a response body.
Restores a previously soft-deleted instance. You cannot use this method to restore deleted instances.
Specify the restore action in the request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"restore": null
}
This operation does not return a response body.
Evacuates servers.
Specify the evacuate action in the request body.
Evacuates a server from a failed host to a new one.
Specify the evacuate action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| evacuate | plain | xsd:string |
Specify the |
| host | plain | xsd:string |
The name or ID of the host to which the server is evacuated. |
| admin_password (Optional) | plain | xsd:string |
An administrative password to access the evacuated instance.
To set the administrative password, set the
|
| on_shared_storage | plain | xsd:string |
Set to |
{
"evacuate": {
"host": "b419863b7d814906a68fb31703c0dbd6",
"admin_password": "MySecretPass",
"on_shared_storage": "False"
}
}
{
"admin_password": "MySecretPass"
}
Gets the usage data for a server.
Gets basic usage data for a specified server.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"cpu0_time": 17300000000,
"memory": 524288,
"vda_errors": -1,
"vda_read": 262144,
"vda_read_req": 112,
"vda_write": 5778432,
"vda_write_req": 488,
"vnet1_rx": 2070139,
"vnet1_rx_drop": 0,
"vnet1_rx_errors": 0,
"vnet1_rx_packets": 26701,
"vnet1_tx": 140208,
"vnet1_tx_drop": 0,
"vnet1_tx_errors": 0,
"vnet1_tx_packets": 662
}
This operation does not accept a request body.
Lists the IP addresses assigned to an instance or shows details for a specified IP address.
Lists IP addresses that are assigned to an instance.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"version": 4
}
]
}
}
This operation does not accept a request body.
Shows details for a specified IP address for a specified server instance.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"private": [
{
"addr": "192.168.0.3",
"version": 4
}
]
}
This operation does not accept a request body.
Lists metadata, creates or replaces one or more metadata items, and updates one or more metadata items for a server.
Shows details for, creates or replaces, and updates a specified metadata item, by key, for a server.
Lists all metadata for a specified server.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"metadata": {
"foo": "Foo Value"
}
}
This operation does not accept a request body.
Creates or replaces one or more specified metadata items for a specified server.
Creates any metadata items that do not already exist in the server. Removes and completely replaces any metadata items that already exist in the server with the metadata items in the request.
If this operation exceeds the quota for metadata items, the API throws an overLimit (413)
fault.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"metadata": {
"foo": "Foo Value"
}
}
{
"metadata": {
"foo": "Foo Value"
}
}
Updates one or more metadata items for a specified server.
Replaces metadata items that match the specified keys. Does not modify items that are not specified in the request.
If this operation exceeds the quota for metadata items, the
API throws an overLimit (413) fault.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"metadata": {
"foo": "Foo Value"
}
}
{
"metadata": {
"foo": "Foo Value"
}
}
Shows details for a specified metadata item, by key, for a specified server.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| key | URI | xsd:string |
The metadata key. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"meta": {
"foo": "Foo Value"
}
}
This operation does not accept a request body.
Creates or replaces a specified metadata item, by key, for a specified server.
Creates a metadata item that does not already exist in the server. Removes and completely replaces a metadata item that already exists in the server with the metadata item in the request.
If this operation exceeds the quota for metadata items, the API throws an overLimit (413)
fault.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| key | URI | xsd:string |
The metadata key. |
{
"meta": {
"foo": "Bar Value"
}
}
{
"meta": {
"foo": "Foo Value"
}
}
Deletes a specified metadata item, by key, from a specified server.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| key | URI | xsd:string |
The metadata key. |
This operation does not accept a request body and does not return a response body.
Shows server details including configuration drive information for a specified server ID or user.
Shows details for a specified server. Includes configuration drive information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"server": {
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-22T02:33:23Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "1642bbdbd61a0f1c513b4bb6e418326103172698104bfa278eca106b",
"id": "7838ff1b-b71f-48b9-91e9-7c08de20b249",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/7838ff1b-b71f-48b9-91e9-7c08de20b249",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/7838ff1b-b71f-48b9-91e9-7c08de20b249",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"config_drive": "",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-22T02:33:25Z",
"user_id": "fake"
}
}
This operation does not accept a request body.
Lists server details. Includes configuration drive information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"servers": [
{
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-09-22T02:33:17Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "1ed067c90341cd9d94bbe5da960922b56f107262cdc75719a0d97b78",
"id": "f0318e69-11eb-4aed-9840-59b6c72beee8",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/f0318e69-11eb-4aed-9840-59b6c72beee8",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/f0318e69-11eb-4aed-9840-59b6c72beee8",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"config_drive": "",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-09-22T02:33:19Z",
"user_id": "fake"
}
]
}
This operation does not accept a request body.
Gets the encrypted administrative password set through the metadata service.
Gets the administrative password for a specified server.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
{
"password": "xlozO3wLCBRWAa2yDjCCVx8vwNPypxnypmRYDa/zErlQ+EzPe1S/Gz6nfmC52mOlOSCRuUOmG7kqqgejPof6M7bOezS387zjq4LSvvwp28zUknzy4YzfFGhnHAdai3TxUJ26pfQCYrq8UTzmKF2Bq8ioSEtVVzM0A96pDh8W2i7BOz6MdoiVyiev/I1K2LsuipfxSJR7Wdke4zNXJjHHP2RfYsVbZ/k9ANu+Nz4iIH8/7Cacud/pphH7EjrY6a4RZNrjQskrhKYed0YERpotyjYk1eDtRe72GrSiXteqCM4biaQ5w3ruS+AcX//PXk3uJ5kC7d67fPXaVz4WaQRYMg=="
}
This operation does not accept a request body.
Lists all servers and shows server details. Includes server usage information.
Shows OS-SRV-USG:launched_at and OS-SRV-
USG:terminated_at attributes in server responses.
Lists servers. Includes server usage details.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| sort_key (Optional) | query | xsd:string |
Sorts by the requested server attribute. Default is
|
| sort_dir (Optional) | query | xsd:string |
Sort direction. A valid value is |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
| locked | plain | xsd:boolean |
Indicates whether the server is locked ( |
{
"servers": [
{
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-08-15T12:04:04Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "117535ce0eda7ee02ebffe2c976173629385481ae3f2bded5e14a66b",
"id": "ae114799-9164-48f5-a036-6ef9310acbc4",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/ae114799-9164-48f5-a036-6ef9310acbc4",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/ae114799-9164-48f5-a036-6ef9310acbc4",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-SRV-USG:launched_at": "2013-08-15T12:04:05.368766",
"OS-SRV-USG:terminated_at": null,
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-08-15T12:04:05Z",
"user_id": "fake"
}
]
}
Shows details for a specified server. Includes server usage information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
| locked | plain | xsd:boolean |
Indicates whether the server is locked ( |
{
"server": {
"accessIPv4": "1.2.3.4",
"accessIPv6": "80fe::",
"addresses": {
"private": [
{
"addr": "192.168.0.3",
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
"OS-EXT-IPS:type": "fixed",
"version": 4
}
]
},
"created": "2013-08-15T08:12:40Z",
"flavor": {
"id": "1",
"links": [
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
]
},
"hostId": "73cf3a40601b63f5992894be2daa3712dd599d1c919984951e21edda",
"id": "cee6d136-e378-4cfc-9eec-71797f025991",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
},
"key_name": null,
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/cee6d136-e378-4cfc-9eec-71797f025991",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/cee6d136-e378-4cfc-9eec-71797f025991",
"rel": "bookmark"
}
],
"metadata": {
"My Server Name": "Apache1"
},
"name": "new-server-test",
"OS-SRV-USG:launched_at": "2013-08-15T08:12:40.108903",
"OS-SRV-USG:terminated_at": null,
"progress": 0,
"status": "ACTIVE",
"tenant_id": "openstack",
"updated": "2013-08-15T08:12:40Z",
"user_id": "fake"
}
}
This operation does not accept a request body.
Lists virtual interfaces for a specified server instance.
Lists the virtual interfaces for a specified instance.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| virtual_interfaces | plain | xsd:string |
A |
| id | plain | csapi:UUID |
The ID of the virtual interface. |
| mac_address | plain | xsd:string |
The MAC address. |
| net_id | plain | csapi:UUID |
The ID of the virtual network. |
{
"virtual_interfaces": [
{
"id": "cec8b9bb-5d22-4104-b3c8-4c35db3210a6",
"mac_address": "fa:16:3e:3c:ce:6f",
"net_id": "cec8b9bb-5d22-4104-b3c8-4c35db3210a7"
}
]
}
This operation does not accept a request body.
Shows information about flavors with extended attributes.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"flavors": [
{
"id": "1",
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny"
},
{
"id": "2",
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/flavors/2",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/2",
"rel": "bookmark"
}
],
"name": "m1.small"
},
{
"id": "3",
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/flavors/3",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/3",
"rel": "bookmark"
}
],
"name": "m1.medium"
},
{
"id": "4",
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/flavors/4",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/4",
"rel": "bookmark"
}
],
"name": "m1.large"
},
{
"id": "5",
"links": [
{
"href": "http://openstack.example.com/v2.1/openstack/flavors/5",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/5",
"rel": "bookmark"
}
],
"name": "m1.xlarge"
}
]
}
This operation does not return a response body.
Shows details for a specified flavor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"flavor": {
"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.1/openstack/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"ram": 512,
"swap": "",
"vcpus": 1
}
}
This operation does not return a response body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"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.1/openstack/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"ram": 512,
"swap": "",
"vcpus": 1
},
{
"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.1/openstack/flavors/2",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/2",
"rel": "bookmark"
}
],
"name": "m1.small",
"ram": 2048,
"swap": "",
"vcpus": 1
},
{
"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.1/openstack/flavors/3",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/3",
"rel": "bookmark"
}
],
"name": "m1.medium",
"ram": 4096,
"swap": "",
"vcpus": 2
},
{
"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.1/openstack/flavors/4",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/4",
"rel": "bookmark"
}
],
"name": "m1.large",
"ram": 8192,
"swap": "",
"vcpus": 4
},
{
"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.1/openstack/flavors/5",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/flavors/5",
"rel": "bookmark"
}
],
"name": "m1.xlarge",
"ram": 16384,
"swap": "",
"vcpus": 8
}
]
}
This operation does not return a response body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"flavor": {
"name": "flavortest",
"ram": 1024,
"vcpus": 2,
"disk": 10,
"id": "100",
"rxtx_factor": 2.0
}
}
{
"flavor": {
"OS-FLV-DISABLED:disabled": false,
"disk": 10,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"id": "100",
"links": [
{
"href": "http://openstack.example.com/v2.1/flavors/100",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/100",
"rel": "bookmark"
}
],
"name": "flavortest",
"ram": 1024,
"rxtx_factor": 2.0,
"swap": "",
"vcpus": 2
}
}
Lists flavors with details.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"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.1/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"ram": 512,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 1
},
{
"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.1/flavors/2",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/2",
"rel": "bookmark"
}
],
"name": "m1.small",
"ram": 2048,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 1
},
{
"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.1/flavors/3",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/3",
"rel": "bookmark"
}
],
"name": "m1.medium",
"ram": 4096,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 2
},
{
"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.1/flavors/4",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/4",
"rel": "bookmark"
}
],
"name": "m1.large",
"ram": 8192,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 4
},
{
"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.1/flavors/5",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/5",
"rel": "bookmark"
}
],
"name": "m1.xlarge",
"ram": 16384,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 8
}
]
}
This operation does not accept a request body.
Shows details for a specified flavor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"flavor": {
"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.1/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"ram": 512,
"rxtx_factor": 1.0,
"swap": "",
"vcpus": 1
}
}
This operation does not accept a request body.
Provides flavor access support.
Creates a flavor with access list.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"flavor": {
"name": "test_flavor",
"ram": 1024,
"vcpus": 2,
"disk": 10,
"id": "10",
"os-flavor-access:is_public": false
}
}
{
"flavor": {
"OS-FLV-DISABLED:disabled": false,
"disk": 10,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": false,
"id": "10",
"links": [
{
"href": "http://openstack.example.com/v2.1/flavors/10",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/10",
"rel": "bookmark"
}
],
"name": "test_flavor",
"ram": 1024,
"swap": "",
"vcpus": 2
}
}
Lists flavors with access list information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"flavor_access": [
{
"flavor_id": "10",
"tenant_id": "fake_tenant"
}
]
}
This operation does not accept a request body.
Shows details for a specified flavor. Includes access list information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"flavor": {
"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.1/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"ram": 512,
"swap": "",
"vcpus": 1
}
}
This operation does not accept a request body.
Adds flavor access to a specified tenant and flavor.
Specify the add_tenant_access action and the tenant_id in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
{
"addTenantAccess": {
"tenant": "fake_tenant"
}
}
{
"flavor_access": [
{
"flavor_id": "10",
"tenant_id": "fake_tenant"
}
]
}
Removes the specified flavor access from a specified tenant and flavor.
Specify the remove_tenant_access action and the
tenant_id in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
{
"removeTenantAccess": {
"tenant": "fake_tenant"
}
}
{
"flavor_access": []
}
Lists flavors with details. Includes access list information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"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.1/flavors/1",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/1",
"rel": "bookmark"
}
],
"name": "m1.tiny",
"ram": 512,
"swap": "",
"vcpus": 1
},
{
"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.1/flavors/2",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/2",
"rel": "bookmark"
}
],
"name": "m1.small",
"ram": 2048,
"swap": "",
"vcpus": 1
},
{
"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.1/flavors/3",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/3",
"rel": "bookmark"
}
],
"name": "m1.medium",
"ram": 4096,
"swap": "",
"vcpus": 2
},
{
"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.1/flavors/4",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/4",
"rel": "bookmark"
}
],
"name": "m1.large",
"ram": 8192,
"swap": "",
"vcpus": 4
},
{
"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.1/flavors/5",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/5",
"rel": "bookmark"
}
],
"name": "m1.xlarge",
"ram": 16384,
"swap": "",
"vcpus": 8
}
]
}
This operation does not accept a request body.
Lists, creates, deletes, and updates the extra-specs or keys for a flavor.
Creates and updates flavor extra specs.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}
Lists extra specs for a specified flavor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}
Shows an extra spec for specified flavor, by key.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
| flavor_extra_spec_key | URI | xsd:string |
The extra spec key for the flavor. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"extra_specs": {
"key1": "value1",
"key2": "value2"
}
}
{
"key1": "value1"
}
Updates a specified extra spec value, by key, for a specified flavor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
| flavor_extra_spec_key | URI | xsd:string |
The extra spec key for the flavor. |
{
"key1": "new_value1"
}
{
"key1": "new_value1"
}
Creates and deletes flavors.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"flavor": {
"name": "test_flavor",
"ram": 1024,
"vcpus": 2,
"disk": 10,
"id": "10"
}
}
{
"flavor": {
"OS-FLV-DISABLED:disabled": false,
"disk": 10,
"OS-FLV-EXT-DATA:ephemeral": 0,
"os-flavor-access:is_public": true,
"id": "10",
"links": [
{
"href": "http://openstack.example.com/v2.1/flavors/10",
"rel": "self"
},
{
"href": "http://openstack.example.com/flavors/10",
"rel": "bookmark"
}
],
"name": "test_flavor",
"ram": 1024,
"swap": "",
"vcpus": 2
}
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| flavor_id | URI | csapi:UUID |
The flavor ID. |
{
"flavor": {
"name": "test_flavor",
"ram": 1024,
"vcpus": 2,
"disk": 10,
"id": "10"
}
}
This operation does not return a response body.
Generates, imports, and deletes SSH keys.
Lists keypairs that are associated with the account.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| user_id (Optional) | query | xsd:string |
The user ID of the user who runs the operation. |
{
"keypairs": [
{
"keypair": {
"fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
"name": "keypair-50ca852e-273f-4cdc-8949-45feba200837",
"type": "ssh",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCkF3MX59OrlBs3dH5CU7lNmvpbrgZxSpyGjlnE8Flkirnc/Up22lpjznoxqeoTAwTW034k7Dz6aYIrZGmQwe2TkE084yqvlj45Dkyoj95fW/sZacm0cZNuL69EObEGHdprfGJQajrpz22NQoCD8TFB8Wv+8om9NH9Le6s+WPe98WC77KLw8qgfQsbIey+JawPWl4O67ZdL5xrypuRjfIPWjgy/VH85IXg/Z/GONZ2nxHgSShMkwqSFECAC5L3PHB+0+/12M/iikdatFSVGjpuHvkLOs3oe7m6HlOfluSJ85BzLWBbvva93qkGmLg4ZAc8rPh2O+YIsBUHNLLMM/oQp Generated-by-Nova\n"
}
}
]
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| name | plain | xsd:string |
The name to associate with the keypair. |
| type (Optional) | plain | xsd:string |
The keypair type. |
| public_key (Optional) | plain | xsd:string |
The public ssh key to import. If you omit this value, a key is generated. |
| user_id (Optional) | plain | xsd:string |
The user ID of the user who runs the operation. |
| user_id (Optional) | query | xsd:string |
The user ID of the user who runs the operation. |
{
"keypair": {
"name": "keypair-d20a3d59-9433-4b79-8726-20b431d89c78",
"type": "ssh",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDx8nkQv/zgGgB4rMYmIf+6A4l6Rr+o/6lHBQdW5aYd44bd8JttDCE/F/pNRr0lRE+PiqSPO8nDPHw0010JeMH9gYgnnFlyY3/OcJ02RhIPyyxYpv9FhY+2YiUkpwFOcLImyrxEsYXpD/0d3ac30bNH6Sw9JD9UZHYcpSxsIbECHw== Generated-by-Nova",
"user_id": "fake"
}
}
{
"keypair": {
"fingerprint": "1e:2c:9b:56:79:4b:45:77:f9:ca:7a:98:2c:b0:d5:3c",
"name": "keypair-803a1926-af78-4b05-902a-1d6f7a8d9d3e",
"type": "ssh",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDx8nkQv/zgGgB4rMYmIf+6A4l6Rr+o/6lHBQdW5aYd44bd8JttDCE/F/pNRr0lRE+PiqSPO8nDPHw0010JeMH9gYgnnFlyY3/OcJ02RhIPyyxYpv9FhY+2YiUkpwFOcLImyrxEsYXpD/0d3ac30bNH6Sw9JD9UZHYcpSxsIbECHw== Generated-by-Nova",
"user_id": "fake"
}
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| keypair_name | URI | xsd:string |
The keypair name. |
| user_id (Optional) | query | xsd:string |
The user ID of the user who runs the operation. |
This operation does not accept a request body and does not return a response body.
Shows a keypair that is associated with the account.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| keypair_name | URI | xsd:string |
The keypair name. |
| user_id (Optional) | query | xsd:string |
The user ID of the user who runs the operation. |
{
"keypair": {
"fingerprint": "44:fe:29:6e:23:14:b9:53:5b:65:82:58:1c:fe:5a:c3",
"name": "keypair-6638abdb-c4e8-407c-ba88-c8dd7cc3c4f1",
"type": "ssh",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC1HTrHCbb9NawNLSV8N6tSa8i637+EC2dA+lsdHHfQlT54t+N0nHhJPlKWDLhc579j87vp6RDFriFJ/smsTnDnf64O12z0kBaJpJPH2zXrBkZFK6q2rmxydURzX/z0yLSCP77SFJ0fdXWH2hMsAusflGyryHGX20n+mZK6mDrxVzGxEz228dwQ5G7Az5OoZDWygH2pqPvKjkifRw0jwUKf3BbkP0QvANACOk26cv16mNFpFJfI1N3OC5lUsZQtKGR01ptJoWijYKccqhkAKuo902tg/qup58J5kflNm7I61sy1mJon6SGqNUSfoQagqtBH6vd/tU1jnlwZ03uUroAL Generated-by-Nova\n",
"user_id": "fake",
"deleted": false,
"created_at": "2014-05-07T12:06:13.681238",
"updated_at": null,
"deleted_at": null,
"id": 1
}
}
This operation does not accept a request body.
Shows all global and rate limit information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"limits": {
"absolute": {
"maxImageMeta": 128,
"maxPersonality": 5,
"maxPersonalitySize": 10240,
"maxSecurityGroupRules": 20,
"maxSecurityGroups": 10,
"maxServerMeta": 128,
"maxTotalCores": 20,
"maxTotalFloatingIps": 10,
"maxTotalInstances": 10,
"maxTotalKeypairs": 100,
"maxTotalRAMSize": 51200,
"maxServerGroups": 10,
"maxServerGroupMembers": 10,
"totalCoresUsed": 0,
"totalInstancesUsed": 0,
"totalRAMUsed": 0,
"totalSecurityGroupsUsed": 0,
"totalFloatingIpsUsed": 0,
"totalServerGroupsUsed": 0
},
"rate": []
}
}
This operation does not accept a request body.
Available extensions.
| Parameter | Style | Type | Description |
|---|---|---|---|
| next (Optional) | plain | xsd:anyURI |
Moves to the next metadata item. |
| previous (Optional) | plain | xsd:anyURI |
Moves to the previous metadata item. |
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"extension": {
"alias": "os-create-backup",
"description": "Create a backup of a server.",
"links": [],
"name": "CreateBackup",
"namespace": "http://docs.openstack.org/compute/ext/fake_xml",
"updated": "2014-12-03T00:00:00Z"
}
}
This operation does not accept a request body.
Extensions introduce features and vendor-specific functionality to the API without requiring a version change.
| Parameter | Style | Type | Description |
|---|---|---|---|
| alias | URI | xsd:string |
An alias, which is a name for a pointer to a resource. For example, a named extension. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"extension": {
"updated": "2011-09-27T00:00:00+00:00",
"name": "DiskConfig",
"links": [],
"namespace": "http://docs.openstack.org/compute/ext/disk_config/api/v1.1",
"alias": "OS-DCF",
"description": "Disk Management Extension."
}
}
This operation does not accept a request body.
Lists, gets details for, and deletes images. Also sets, lists, gets details for, and deletes image metadata.
An image is a collection of files that you use to create and rebuild a server. By default, operators provide pre-built operating system images. You can also create custom images. See Compute server actions.
If you set the image size policy in the policy.json
file, the OS-EXT-IMG-SIZE:size extended attribute is
visible.
| Parameter | Style | Type | Description |
|---|---|---|---|
| changes-since (Optional) | query | xsd:dateTime |
The date and time when the image last changed status.
Use this query parameter to check for changes since a previous request
rather than re-downloading and re-parsing the full status at each polling
interval. If data has changed, the call returns only the items changed
since the specified time. If data has not changed since the
To enable you to keep track of changes, this filter also displays images
that were deleted if the The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm
The For example, If you omit the time zone, the UTC time zone is assumed. |
| server (Optional) | query | xsd:anyURI |
Name of the server in URL format. |
| name (Optional) | query | xsd:string |
Name of the image as a string. |
| status (Optional) | query | csapi:ImageStatus |
Value of the image statuses.
For example, you can filter on |
| type (Optional) | query | xsd:string |
Value of the type of image, such as snapshot or backup. |
| limit (Optional) | query | xsd:int |
Requests a specified page size of returned items from the query.
Returns a number of items up to the specified limit value. Use the
|
| marker (Optional) | query | xsd:string |
Specifies the ID of the last-seen item. Use the |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-Compute-Request-ID (Optional) | header | xsd:string |
Returns a unique identifier to provide tracking for the request. The request ID associated with the request appears in the log lines for that request. By default, the middleware configuration ensures the request ID appears in the log files. |
| images | plain | csapi:ImagesWithOnlyIDsNamesLinks |
Image information. |
| next (Optional) | plain | xsd:anyURI |
Moves to the next metadata item. |
| previous (Optional) | plain | xsd:anyURI |
Moves to the previous metadata item. |
{
"images": [
{
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage7"
},
{
"id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage123456"
},
{
"id": "a2459075-d96c-40d5-893e-577ff92e721c",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/a2459075-d96c-40d5-893e-577ff92e721c",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/a2459075-d96c-40d5-893e-577ff92e721c",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/a2459075-d96c-40d5-893e-577ff92e721c",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage123456"
},
{
"id": "a440c04b-79fa-479c-bed1-0b816eaec379",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/a440c04b-79fa-479c-bed1-0b816eaec379",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/a440c04b-79fa-479c-bed1-0b816eaec379",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/a440c04b-79fa-479c-bed1-0b816eaec379",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage6"
},
{
"id": "c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage123456"
},
{
"id": "cedef40a-ed67-4d10-800e-17455edce175",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/cedef40a-ed67-4d10-800e-17455edce175",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/cedef40a-ed67-4d10-800e-17455edce175",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/cedef40a-ed67-4d10-800e-17455edce175",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage123456"
},
{
"id": "76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"name": "fakeimage123456"
}
]
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| changes-since (Optional) | query | xsd:dateTime |
The date and time when the image last changed status.
Use this query parameter to check for changes since a previous request
rather than re-downloading and re-parsing the full status at each polling
interval. If data has changed, the call returns only the items changed
since the specified time. If data has not changed since the
To enable you to keep track of changes, this filter also displays images
that were deleted if the The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm
The For example, If you omit the time zone, the UTC time zone is assumed. |
| server (Optional) | query | xsd:anyURI |
Name of the server in URL format. |
| name (Optional) | query | xsd:string |
Name of the image as a string. |
| status (Optional) | query | csapi:ImageStatus |
Value of the image statuses.
For example, you can filter on |
| type (Optional) | query | xsd:string |
Value of the type of image, such as snapshot or backup. |
| limit (Optional) | query | xsd:int |
Requests a specified page size of returned items from the query.
Returns a number of items up to the specified limit value. Use the
|
| marker (Optional) | query | xsd:string |
Specifies the ID of the last-seen item. Use the |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-Compute-Request-ID (Optional) | header | xsd:string |
Returns a unique identifier to provide tracking for the request. The request ID associated with the request appears in the log lines for that request. By default, the middleware configuration ensures the request ID appears in the log files. |
| next (Optional) | plain | xsd:anyURI |
Moves to the next metadata item. |
| previous (Optional) | plain | xsd:anyURI |
Moves to the previous metadata item. |
{
"images": [
{
"OS-EXT-IMG-SIZE:size": "74185822",
"created": "2011-01-01T01:02:03Z",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"architecture": "x86_64",
"auto_disk_config": "True",
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage7",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
},
{
"OS-EXT-IMG-SIZE:size": "74185821",
"created": "2011-01-01T01:02:03Z",
"id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"architecture": "x86_64",
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage123456",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
},
{
"created": "2011-01-01T01:02:03Z",
"id": "a2459075-d96c-40d5-893e-577ff92e721c",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/a2459075-d96c-40d5-893e-577ff92e721c",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/a2459075-d96c-40d5-893e-577ff92e721c",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/a2459075-d96c-40d5-893e-577ff92e721c",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage123456",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
},
{
"created": "2011-01-01T01:02:03Z",
"id": "a440c04b-79fa-479c-bed1-0b816eaec379",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/a440c04b-79fa-479c-bed1-0b816eaec379",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/a440c04b-79fa-479c-bed1-0b816eaec379",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/a440c04b-79fa-479c-bed1-0b816eaec379",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"architecture": "x86_64",
"auto_disk_config": "False",
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage6",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
},
{
"created": "2011-01-01T01:02:03Z",
"id": "c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"kernel_id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
"ramdisk_id": null
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage123456",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
},
{
"created": "2011-01-01T01:02:03Z",
"id": "cedef40a-ed67-4d10-800e-17455edce175",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/cedef40a-ed67-4d10-800e-17455edce175",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/cedef40a-ed67-4d10-800e-17455edce175",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/cedef40a-ed67-4d10-800e-17455edce175",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage123456",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
},
{
"created": "2011-01-01T01:02:03Z",
"id": "76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage123456",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
}
]
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-Compute-Request-ID (Optional) | header | xsd:string |
Returns a unique identifier to provide tracking for the request. The request ID associated with the request appears in the log lines for that request. By default, the middleware configuration ensures the request ID appears in the log files. |
{
"image": {
"OS-EXT-IMG-SIZE:size": "74185822",
"created": "2011-01-01T01:02:03Z",
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
"href": "http://openstack.example.com/v2.1/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "self"
},
{
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
},
{
"href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "alternate",
"type": "application/vnd.openstack.image"
}
],
"metadata": {
"architecture": "x86_64",
"auto_disk_config": "True",
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
},
"minDisk": 0,
"minRam": 0,
"name": "fakeimage7",
"progress": 100,
"status": "ACTIVE",
"updated": "2011-01-01T01:02:03Z"
}
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
This operation does not accept a request body and does not return a response body.
Shows details for, sets, updates, and deletes image metadata or metadata items.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-Compute-Request-ID (Optional) | header | xsd:string |
Returns a unique identifier to provide tracking for the request. The request ID associated with the request appears in the log lines for that request. By default, the middleware configuration ensures the request ID appears in the log files. |
| next (Optional) | plain | xsd:anyURI |
Moves to the next metadata item. |
| previous (Optional) | plain | xsd:anyURI |
Moves to the previous metadata item. |
{
"metadata": {
"architecture": "x86_64",
"auto_disk_config": "True",
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
}
}
This operation does not accept a request body.
Creates or replaces metadata for a specified image.
Replaces items that match the specified keys. If you omit a key that already exists, this key retains its value.
If this operation exceeds the metadata items quota, the API throws
an overLimit (413) fault.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| next (Optional) | plain | xsd:anyURI |
Moves to the next metadata item. |
| previous (Optional) | plain | xsd:anyURI |
Moves to the previous metadata item. |
{
"metadata": {
"auto_disk_config": "True",
"Label": "Changed"
}
}
{
"metadata": {
"Label": "Changed",
"auto_disk_config": "True"
}
}
Updates metadata items by key for a specified image.
Replaces items that match the specified keys and does not modify items not specified in the request.
If this operation exceeds the metadata items quota, the API throws
an overLimit (413) fault.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| next (Optional) | plain | xsd:anyURI |
Moves to the next metadata item. |
| previous (Optional) | plain | xsd:anyURI |
Moves to the previous metadata item. |
{
"metadata": {
"kernel_id": "False",
"Label": "UpdatedImage"
}
}
{
"metadata": {
"Label": "UpdatedImage",
"architecture": "x86_64",
"auto_disk_config": "True",
"kernel_id": "False",
"ramdisk_id": "nokernel"
}
}
Shows details for a metadata item by key for a specified image.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| key | URI | csapi:imageMetadataKey |
A string. Maximum length is 255 characters. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-Compute-Request-ID (Optional) | header | xsd:string |
Returns a unique identifier to provide tracking for the request. The request ID associated with the request appears in the log lines for that request. By default, the middleware configuration ensures the request ID appears in the log files. |
{
"metadata": {
"architecture": "x86_64",
"auto_disk_config": "True",
"kernel_id": "nokernel",
"ramdisk_id": "nokernel"
}
}
This operation does not accept a request body.
Creates or updates a metadata item by key for a specified image.
If this operation exceeds the metadata items quota,
the API throws an overLimit (413) fault.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| key | URI | csapi:imageMetadataKey |
A string. Maximum length is 255 characters. |
{
"metadata": {
"auto_disk_config": "True",
"Label": "Changed"
}
}
{
"metadata": {
"Label": "Changed",
"auto_disk_config": "True"
}
}
Deletes a metadata item by key for a specified image.
| Parameter | Style | Type | Description |
|---|---|---|---|
| image_id | URI | csapi:UUID |
The UUID for the image. |
| key | URI | csapi:imageMetadataKey |
A string. Maximum length is 255 characters. |
This operation does not accept a request body and does not return a response body.
Creates, lists, updates, and deletes guest agent builds. Use guest agents to access files on the disk, configure networking, or run other applications or scripts in the guest while the agent runs. This hypervisor-specific extension is not currently enabled for KVM. Use of guest agents is possible only if the underlying service provider uses the Xen driver.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"agent": {
"hypervisor": "hypervisor",
"os": "os",
"architecture": "x86",
"version": "8.0",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"url": "http://example.com/path/to/resource"
}
}
{
"agent": {
"agent_id": 1,
"architecture": "x86",
"hypervisor": "hypervisor",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"os": "os",
"url": "http://example.com/path/to/resource",
"version": "8.0"
}
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"agents": [
{
"agent_id": 1,
"architecture": "x86",
"hypervisor": "hypervisor",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"os": "os",
"url": "http://example.com/path/to/resource",
"version": "8.0"
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
This operation does not accept a request body and does not return a response body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The agent build ID. |
| url | plain | xsd:string |
The URL associated with the agent. |
| md5hash | plain | xsd:string |
The MD5 hash. |
| version | plain | xsd:string |
The version. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| agent_id | plain | xsd:int |
The agent ID. |
| url | plain | xsd:string |
The URL associated with the agent. |
| md5hash | plain | xsd:string |
The MD5 hash. |
| version | plain | xsd:string |
The version. |
{
"para": {
"url": "http://example.com/path/to/resource",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"version": "7.0"
}
}
{
"agent": {
"agent_id": "1",
"md5hash": "add6bb58e139be103324d04d82d8f545",
"url": "http://example.com/path/to/resource",
"version": "7.0"
}
}
Creates and manages host aggregates. An aggregate assigns metadata to groups of compute nodes. Aggregates are only visible to the cloud provider.
Creates a specified aggregate in a specified availability zone.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"aggregate": {
"name": "name",
"availability_zone": "nova"
}
}
{
"aggregate": {
"availability_zone": "nova",
"created_at": "2013-08-18T12:17:55.751757",
"deleted": false,
"deleted_at": null,
"id": 1,
"name": "name",
"updated_at": null
}
}
Lists aggregates id, name, and availability_zone for an aggregate.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"aggregate": {
"name": "name",
"availability_zone": "nova"
}
}
{
"aggregates": [
{
"availability_zone": "nova",
"created_at": "2013-08-18T12:17:56.856455",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
},
"name": "name",
"updated_at": null
}
]
}
Shows the details of an aggregate, hosts and metadata included.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| aggregate_id | URI | csapi:UUID |
The aggregate ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"aggregate": {
"name": "name",
"availability_zone": "nova"
}
}
{
"aggregate": {
"availability_zone": "nova",
"created_at": "2013-08-18T12:17:56.380226",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
},
"name": "name",
"updated_at": null
}
}
Updates either or both the name and availability zone for a specified aggregate.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| aggregate_id | URI | csapi:UUID |
The aggregate ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"aggregate": {
"name": "newname",
"availability_zone": "nova2"
}
}
{
"aggregate": {
"availability_zone": "nova2",
"created_at": "2013-08-18T12:17:56.259751",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova2"
},
"name": "newname",
"updated_at": "2013-08-18T12:17:56.286720"
}
}
Adds a host to the specified aggregate.
Specify the add_host action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| aggregate_id | URI | csapi:UUID |
The aggregate ID. |
{
"add_host": {
"host": "21549b2f665945baaa7101926a00143c"
}
}
{
"aggregate": {
"availability_zone": "nova",
"created_at": "2013-08-18T12:17:56.297823",
"deleted": false,
"deleted_at": null,
"hosts": [
"21549b2f665945baaa7101926a00143c"
],
"id": 1,
"metadata": {
"availability_zone": "nova"
},
"name": "name",
"updated_at": null
}
}
Creates or replaces metadata for an aggregate.
Specify the add_metadata action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| aggregate_id | URI | csapi:UUID |
The aggregate ID. |
{
"set_metadata": {
"metadata": {
"key": "value"
}
}
}
{
"aggregate": {
"availability_zone": "nova",
"created_at": "2013-08-18T12:17:55.959571",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova",
"key": "value"
},
"name": "name",
"updated_at": null
}
}
Removes a host from a specified aggregate.
Specify the remove_host action in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| aggregate_id | URI | csapi:UUID |
The aggregate ID. |
{
"remove_host": {
"host": "bf1454b3d71145d49fca2101c56c728d"
}
}
{
"aggregate": {
"availability_zone": "nova",
"created_at": "2013-08-18T12:17:56.990581",
"deleted": false,
"deleted_at": null,
"hosts": [],
"id": 1,
"metadata": {
"availability_zone": "nova"
},
"name": "name",
"updated_at": null
}
}
Creates, lists, gets details for, and deletes port interfaces.
Creates a port interface and uses it to attach a port to a server instance.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
| interfaceAttachment | plain | xsd:string |
Specify the |
| port_id (Optional) | plain | csapi:uuid |
The ID of the port for which you want to create an interface.
The
If you do not specify the |
| net_id (Optional) | plain | csapi:uuid |
The ID of the network for which you want to create a port interface.
The
If you do not specify the |
| fixed_ips (Optional) | plain | xsd:string |
Fixed IP addresses with subnet IDs.
If you request a specific fixed IP address without
a |
| Parameter | Style | Type | Description |
|---|---|---|---|
| fixed_ips | plain | xsd:string |
Fixed IP addresses with subnet IDs. |
| mac_addr | plain | xsd:string |
The MAC address. |
| net_id | plain | csapi:uuid |
The network ID. |
| port_id | plain | csapi:uuid |
The port ID. |
| port_state | plain | xsd:string |
The port state. |
{
"interfaceAttachment": {
"port_id": "ce531f90-199f-48c0-816c-13e38010b442"
}
}
{
"interfaceAttachment": {
"fixed_ips": [
{
"ip_address": "192.168.1.3",
"subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef"
}
],
"mac_addr": "fa:16:3e:4c:2c:30",
"net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
"port_id": "ce531f90-199f-48c0-816c-13e38010b442",
"port_state": "ACTIVE"
}
}
Lists port interfaces that are attached to a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| port_state | plain | xsd:string |
The port state. |
| fixed_ips | plain | xsd:string |
Fixed IP addresses with subnet IDs. |
| mac_addr | plain | xsd:string |
The MAC address. |
| net_id | plain | csapi:uuid |
The network ID. |
| port_id | plain | csapi:uuid |
The port ID. |
{
"interfaceAttachments": [
{
"fixed_ips": [
{
"ip_address": "192.168.1.3",
"subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef"
}
],
"mac_addr": "fa:16:3e:4c:2c:30",
"net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
"port_id": "ce531f90-199f-48c0-816c-13e38010b442",
"port_state": "ACTIVE"
}
]
}
This operation does not accept a request body.
Shows information about a specified port interface that is attached to a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
| attachment_id | URI | csapi:UUID |
The interface ID. |
{
"interfaceAttachment": {
"fixed_ips": [
{
"ip_address": "192.168.1.3",
"subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef"
}
],
"mac_addr": "fa:16:3e:4c:2c:30",
"net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
"port_id": "ce531f90-199f-48c0-816c-13e38010b442",
"port_state": "ACTIVE"
}
}
This operation does not accept a request body.
Detaches a specified port interface.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
| attachment_id | URI | csapi:UUID |
The interface ID. |
This operation does not accept a request body and does not return a response body.
Gets availability zone information.
Gets availability zone information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"availabilityZoneInfo": [
{
"zoneState": {
"available": true
},
"hosts": null,
"zoneName": "nova"
}
]
}
This operation does not accept a request body.
Gets detailed availability zone information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"availabilityZoneInfo": [
{
"zoneState": {
"available": true
},
"hosts": {
"test-host": {
"nova-conductor": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-cert": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-consoleauth": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-scheduler": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-network": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:54.000000"
}
}
},
"zoneName": "internal"
},
{
"zoneState": {
"available": true
},
"hosts": {
"test-host": {
"nova-compute": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:56.000000"
}
}
},
"zoneName": "nova"
}
]
}
This operation does not accept a request body.
Bare metal nodes.
Adds a bare metal node to a specified server.
Preconditions
You can add a bare metal node to a server with an
ACTIVE, PAUSED,
SHUTOFF, VERIFY_RESIZE, or
SOFT_DELETED status.
You can add a bare metal node to a server with a status that is not locked.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
{
"node": {
"service_host": "host",
"cpus": 8,
"memory_mb": 8192,
"local_gb": 128,
"pm_address": "10.1.2.3",
"pm_user": "pm_user",
"pm_password": "pm_pass",
"terminal_port": 8000
}
}
{
"node": {
"service_host": "host",
"cpus": 8,
"memory_mb": 8192,
"local_gb": 128,
"pm_address": "10.1.2.3",
"pm_user": "pm_user",
"pm_password": "pm_pass",
"prov_mac_address": "12:34:56:78:90:ab",
"terminal_port": 8000
}
}
{
"node": {
"cpus": 8,
"id": 1,
"instance_uuid": null,
"interfaces": [],
"local_gb": 128,
"memory_mb": 8192,
"pm_address": "10.1.2.3",
"pm_user": "pm_user",
"pxe_config_path": null,
"service_host": "host",
"task_state": null,
"terminal_port": 8000,
"updated_at": null,
"uuid": "73d35253-b6fb-4c83-b8eb-0229336e79b6"
}
}
{
"node": {
"cpus": 8,
"id": 1,
"instance_uuid": null,
"interfaces": [
{
"address": "12:34:56:78:90:ab",
"datapath_id": null,
"id": 1,
"port_no": null
}
],
"local_gb": 128,
"memory_mb": 8192,
"pm_address": "10.1.2.3",
"pm_user": "pm_user",
"pxe_config_path": null,
"service_host": "host",
"task_state": null,
"terminal_port": 8000,
"updated_at": null,
"uuid": "0a130464-bccc-4e36-b9d3-9a8c98e636ae"
}
}
Lists the bare metal nodes that are associated with a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
{
"nodes": [
{
"cpus": 8,
"id": 1,
"instance_uuid": null,
"interfaces": [
{
"address": "aa:aa:aa:aa:aa:aa",
"datapath_id": null,
"id": 1,
"port_no": null
}
],
"local_gb": 128,
"memory_mb": 8192,
"pm_address": "10.1.2.3",
"pm_user": "pm_user",
"pxe_config_path": null,
"service_host": "host",
"task_state": null,
"terminal_port": 8000,
"updated_at": null,
"uuid": "6fae68da-108b-4a9d-87c4-88831ee1241b"
}
]
}
This operation does not accept a request body.
Adds an interface to a bare metal node that is associated with a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
{
"add_interface": {
"address": "aa:aa:aa:aa:aa:aa"
}
}
{
"interface": {
"address": "aa:aa:aa:aa:aa:aa",
"datapath_id": null,
"id": 1,
"port_no": null
}
}
Deletes an interface from a bare metal node that is associated with a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
{
"remove_interface": {
"address": "aa:aa:aa:aa:aa:aa"
}
}
This operation does not return a response body.
Shows details for a specified bare metal node.
Preconditions
The specified bare metal node must be associated with the server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
| node_id | URI | xsd:string |
Node ID. |
{
"node": {
"cpus": 8,
"id": 1,
"instance_uuid": null,
"interfaces": [
{
"address": "aa:aa:aa:aa:aa:aa",
"datapath_id": null,
"id": 1,
"port_no": null
}
],
"local_gb": 128,
"memory_mb": 8192,
"pm_address": "10.1.2.3",
"pm_user": "pm_user",
"pxe_config_path": null,
"service_host": "host",
"task_state": null,
"terminal_port": 8000,
"updated_at": null,
"uuid": "c862b836-c7c1-4f7f-8081-6766fa9cf38b"
}
}
This operation does not accept a request body.
Deletes a bare metal node from a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server of interest to you. |
| node_id | URI | xsd:string |
Node ID. |
This operation does not accept a request body and does not return a response body.
Adds neighbor cells, lists neighbor cells, and gets the capabilities of the local cell.
When cells are not enabled, the cells API calls
return a 501 NotImplemented error.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"cells": [
{
"name": "cell1",
"rpc_host": null,
"rpc_port": null,
"type": "child",
"username": "username1"
},
{
"name": "cell3",
"rpc_host": null,
"rpc_port": null,
"type": "child",
"username": "username3"
},
{
"name": "cell5",
"rpc_host": null,
"rpc_port": null,
"type": "child",
"username": "username5"
},
{
"name": "cell2",
"rpc_host": null,
"rpc_port": null,
"type": "parent",
"username": "username2"
},
{
"name": "cell4",
"rpc_host": null,
"rpc_port": null,
"type": "parent",
"username": "username4"
}
]
}
This operation does not accept a request body.
When cells are not enabled, the cells API calls
return a 501 NotImplemented error.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"cells": []
}
This operation does not accept a request body.
When cells are not enabled, the cells API calls
return a 501 NotImplemented error.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| cell_id | URI | csapi:UUID |
The cell ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"cell": {
"name": "cell3",
"rpc_host": null,
"rpc_port": null,
"type": "child",
"username": "username3"
}
}
This operation does not accept a request body.
Shows capacities for a specified cell.
When cells are not enabled, the cells API calls
return a 501 NotImplemented error.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| cell_id | URI | csapi:UUID |
The cell ID. |
{
"cell": {
"capacities": {
"disk_free": {
"total_mb": 1052672,
"units_by_mb": {
"0": 0,
"163840": 5,
"20480": 46,
"40960": 23,
"81920": 11
}
},
"ram_free": {
"total_mb": 7680,
"units_by_mb": {
"16384": 0,
"2048": 3,
"4096": 1,
"512": 13,
"8192": 0
}
}
}
}
}
This operation does not accept a request body.
Creates and shows details for a root certificate.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"certificate": {
"data": "Certificate:\n Data:\n Version: 1 (0x0)\n Serial Number: 1018 (0x3fa)\n Signature Algorithm: md5WithRSAEncryption\n Issuer: O=NOVA ROOT, L=Mountain View, ST=California, C=US\n Validity\n Not Before: Aug 12 07:20:30 2013 GMT\n Not After : Aug 12 07:20:30 2014 GMT\n Subject: C=US, ST=California, O=OpenStack, OU=NovaDev, CN=openstack-fake-2013-08-12T07:20:30Z\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (1024 bit)\n Modulus:\n 00:ac:ff:b1:d1:ed:54:4e:35:6c:34:b4:8f:0b:04:\n 50:25:a3:e2:4f:02:4c:4f:26:59:bd:f3:fd:eb:da:\n 18:c2:36:aa:63:42:72:1f:88:4f:3a:ec:e7:9f:8e:\n 44:2a:d3:b8:94:7b:20:41:f8:48:02:57:91:4c:16:\n 62:f1:21:d4:f2:40:b5:86:50:d9:61:f0:be:ff:d8:\n 8d:9f:4b:aa:6a:07:38:a2:7f:87:21:fc:e6:6e:1d:\n 0a:95:1a:90:0e:60:c2:24:e9:8e:e8:68:1b:e9:f3:\n c6:b0:7c:da:c5:20:66:9b:85:ea:f5:c9:a7:de:ee:\n 16:b1:51:a0:4d:e3:95:98:df\n Exponent: 65537 (0x10001)\n Signature Algorithm: md5WithRSAEncryption\n 15:42:ca:71:cc:32:af:dc:cf:45:91:df:8a:b8:30:c4:7f:78:\n 80:a7:25:c2:d9:81:3e:b3:dd:22:cc:3b:f8:94:e7:8f:04:f6:\n 93:04:9e:85:d4:10:40:ff:5a:07:47:24:b5:ae:93:ad:8d:e1:\n e6:54:4a:8d:4a:29:53:c4:8d:04:6b:0b:f6:af:38:78:02:c5:\n 05:19:89:82:2d:ba:fd:11:3c:1e:18:c9:0c:3d:03:93:6e:bc:\n 66:70:34:ee:03:78:8a:1d:3d:64:e8:20:2f:90:81:8e:49:1d:\n 07:37:15:66:42:cb:58:39:ad:56:ce:ed:47:c6:78:0b:0e:75:\n 29:ca\n-----BEGIN CERTIFICATE-----\nMIICNDCCAZ0CAgP6MA0GCSqGSIb3DQEBBAUAME4xEjAQBgNVBAoTCU5PVkEgUk9P\nVDEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzETMBEGA1UECBMKQ2FsaWZvcm5pYTEL\nMAkGA1UEBhMCVVMwHhcNMTMwODEyMDcyMDMwWhcNMTQwODEyMDcyMDMwWjB2MQsw\nCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTESMBAGA1UECgwJT3BlblN0\nYWNrMRAwDgYDVQQLDAdOb3ZhRGV2MSwwKgYDVQQDDCNvcGVuc3RhY2stZmFrZS0y\nMDEzLTA4LTEyVDA3OjIwOjMwWjCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA\nrP+x0e1UTjVsNLSPCwRQJaPiTwJMTyZZvfP969oYwjaqY0JyH4hPOuznn45EKtO4\nlHsgQfhIAleRTBZi8SHU8kC1hlDZYfC+/9iNn0uqagc4on+HIfzmbh0KlRqQDmDC\nJOmO6Ggb6fPGsHzaxSBmm4Xq9cmn3u4WsVGgTeOVmN8CAwEAATANBgkqhkiG9w0B\nAQQFAAOBgQAVQspxzDKv2.1M9Fkd+KuDDEf3iApyXC2YE+s90izDv4lOePBPaTBJ6F\n1BBA/1oHRyS1rpOtjeHmVEqNSilTxI0Eawv2rzh4AsUFGYmCLbr9ETweGMkMPQOT\nbrxmcDTuA3iKHT1k6CAvkIGOSR0HNxVmQstYOa1Wzu1HxngLDnUpyg==\n-----END CERTIFICATE-----\n",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIICXgIBAAKBgQCs/7HR7VRONWw0tI8LBFAlo+JPAkxPJlm98/3r2hjCNqpjQnIf\niE867OefjkQq07iUeyBB+EgCV5FMFmLxIdTyQLWGUNlh8L7/2I2fS6pqBziif4ch\n/OZuHQqVGpAOYMIk6Y7oaBvp88awfNrFIGabher1yafe7haxUaBN45WY3wIDAQAB\nAoGBAIrcr2I/KyWf0hw4Nn10V9TuyE/9Gz2JHg3QFKjFJox2DqygADT5WAeHc6Bq\nNKNf0NA2SL1LSpm+ql01tvOw4VjE5TF6OHiIzHuTTnXggG6vuA8rxp6L24HtkAcC\n0CBno9ggSX6jVornJPBfxpkwITYSvH57BUFVD7ovbPyWGzS5AkEA1JeUtL6zxwps\nWRr1aJ8Ill2uQk/RUIvSZOU61s+B190zvHikFy8LD8CI6vvBmjC/IZuZVedufjqs\n4vX82uDO3QJBANBSh2b2dyB4AGVFY9vXMRtALAspJHbLHy+zTKxlGPFiuz7Se3ps\n8Kehz4C/CBXgQkk194dwFSGE19/PQfyJROsCQQCFFDJZhrtBUMwMZ2zSRiN5BUGt\nbwuncS+OS1Su3Yz5VRYq2BZYEPHKtYrAFkLWQ8eRwTaWaN5pFE/fb38OgQXdAkA4\nDm0W/K0zlHbuyUxEpNQ28/6mBi0ktiWvLT0tioq6sYmXLwZA/D2JrhXrG/xt/ol3\nr8jqrfNRsLByLhAgh0N/AkEAl2eR0O97lTEgFNqzIQwVmIAn9mBO3cnf3tycvlDU\nm6eb2CS242y4QalfCCAEjxoJURdfsm3/D1iFo00X+IWF+A==\n-----END RSA PRIVATE KEY-----\n"
}
}
This operation does not accept a request body.
Shows details for a specified certificate.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| certificate_id | URI | csapi:UUID |
The certificate ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"certificate": {
"data": "-----BEGIN CERTIFICATE-----\nMIICyzCCAjSgAwIBAgIJAJ8zSIxUp/m4MA0GCSqGSIb3DQEBBAUAME4xEjAQBgNV\nBAoTCU5PVkEgUk9PVDEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzETMBEGA1UECBMK\nQ2FsaWZvcm5pYTELMAkGA1UEBhMCVVMwHhcNMTIxMDE3MDEzMzM5WhcNMTMxMDE3\nMDEzMzM5WjBOMRIwEAYDVQQKEwlOT1ZBIFJPT1QxFjAUBgNVBAcTDU1vdW50YWlu\nIFZpZXcxEzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTMIGfMA0GCSqG\nSIb3DQEBAQUAA4GNADCBiQKBgQDXW4QfQQxJG4MqurqK8nU/Lge0mfNKxXj/Gwvg\n2sQVwxzmKfoxih8Nn6yt0yHMNjhoji1UoWI03TXUnPZRAZmsypGKZeBd7Y1ZOCPB\nXGZVGrQm+PB2kZU+3cD8fVKcueMLLeZ+LRt5d0njnoKhc5xjqMlfFPimHMba4OL6\nTnYzPQIDAQABo4GwMIGtMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFKyoKu4SMOFM\ngx5Ec7p0nrCkabvxMH4GA1UdIwR3MHWAFKyoKu4SMOFMgx5Ec7p0nrCkabvxoVKk\nUDBOMRIwEAYDVQQKEwlOT1ZBIFJPT1QxFjAUBgNVBAcTDU1vdW50YWluIFZpZXcx\nEzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTggkAnzNIjFSn+bgwDQYJ\nKoZIhvcNAQEEBQADgYEAXuvXlu1o/SVvykSLhHW8QiAY00yzN/eDzYmZGomgiuoO\n/x+ayVzbrz1UWZnBD+lC4hll2iELSmf22LjLoF+s/9NyPqHxGL3FrfatBkndaiF8\nAx/TMEyCPl7IQWi+3zzatqOKHSHiG7a9SGn/7o2aNTIWKVulfy5GvmbBjBM/0UE=\n-----END CERTIFICATE-----\n",
"private_key": null
}
}
This operation does not accept a request body.
Manages virtual VPNs for projects.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
{
"cloudpipes": [
{
"created_at": "2012-11-27T17:18:01Z",
"instance_id": "27deecdb-baa3-4a26-9c82-32994b815b01",
"internal_ip": "192.168.0.3",
"project_id": "fa1765bd-a352-49c7-a6b7-8ee108a3cb0c",
"public_ip": "127.0.0.1",
"public_port": 22,
"state": "down"
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| project_id (Optional) | plain | xsd:string |
Creates the cloudpipe for the specified project ID. If omitted, the project ID defaults to the calling tenant. |
{
"cloudpipe": {
"project_id": "059f21e3-c20e-4efc-9e7a-eba2ab3c6f9a"
}
}
{
"instance_id": "1e9b8425-34af-488e-b969-4d46f4a6382e"
}
Updates the virtual private network (VPN) IP address and port for a specified cloudpipe instance.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| vpn_ip | plain | xsd:string |
The VPN IP address. |
| vpn_port | plain | xsd:string |
The VPN port. |
{
"configure_project": {
"vpn_ip": "192.168.1.1",
"vpn_port": "2000"
}
}
This operation does not return a response body.
Shows data for a specified fixed IP, such as host name, CIDR, and address. Also, reserves and frees a fixed IP address.
Shows information for a specified fixed IP address.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| fixed_ip | URI | xsd:string |
The fixed IP of interest to you. |
{
"fixed_ip": {
"address": "192.168.1.1",
"cidr": "192.168.1.0/24",
"host": "host",
"hostname": "openstack"
}
}
This operation does not accept a request body.
Reserves or releases a fixed IP.
To reserve a fixed IP address, specify
reserve in the request body. To
release a fixed IP address, specify
unreserve in the request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID for the tenant or account in a multi-tenancy cloud. |
| fixed_ip | URI | xsd:string |
The fixed IP of interest to you. |
{
"reserve": null
}
This operation does not return a response body.
Manages DNS records associated with IP addresses allocated by the floating IPs extension. Requests are dispatched to a DNS driver selected at startup.
Lists registered DNS domains published by the DNS drivers.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"domain_entries": [
{
"availability_zone": null,
"domain": "domain1.example.org",
"project": "project1",
"scope": "public"
}
]
}
This operation does not accept a request body.
Creates or updates a DNS domain.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| domain | URI | xsd:string |
Registered DNS domain published by the DNS drivers. |
{
"domain_entry": {
"scope": "public",
"project": "project1"
}
}
{
"domain_entry": {
"availability_zone": null,
"domain": "domain1.example.org",
"project": "project1",
"scope": "public"
}
}
Deletes a DNS domain and all associated host entries.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| domain | URI | xsd:string |
Registered DNS domain published by the DNS drivers. |
This operation does not accept a request body and does not return a response body.
Creates or updates a DNS entry.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| domain | URI | xsd:string |
Registered DNS domain published by the DNS drivers. |
| name | URI | xsd:string |
The name of the DNS entry. |
{
"dns_entry": {
"ip": "192.168.53.11",
"dns_type": "A"
}
}
{
"dns_entry": {
"domain": "domain1.example.org",
"id": null,
"ip": "192.168.1.1",
"name": "instance1",
"type": "A"
}
}
Finds a unique DNS entry for a specified domain and name.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| domain | URI | xsd:string |
Registered DNS domain published by the DNS drivers. |
| name | URI | xsd:string |
The name of the DNS entry. |
{
"dns_entry": {
"domain": "domain1.example.org",
"id": null,
"ip": "192.168.1.1",
"name": "instance1",
"type": null
}
}
This operation does not accept a request body.
Deletes a specified DNS entry.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| domain | URI | xsd:string |
Registered DNS domain published by the DNS drivers. |
| name | URI | xsd:string |
The name of the DNS entry. |
This operation does not accept a request body and does not return a response body.
Lists DNS entries for a specified domain and IP.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| domain | URI | xsd:string |
Registered DNS domain published by the DNS drivers. |
| ip | URI | xsd:string |
The IP address. |
{
"dns_entries": [
{
"domain": "domain1.example.org",
"id": null,
"ip": "192.168.1.1",
"name": "instance1",
"type": null
}
]
}
This operation does not accept a request body.
Manages groups of floating IPs.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"floating_ip_pools": [
{
"name": "pool1"
},
{
"name": "pool2"
}
]
}
This operation does not accept a request body.
Assigns and allocates floating IP addresses to instances that run in an OpenStack cloud.
Lists floating IP addresses associated with the tenant or account.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"floating_ips": [
{
"fixed_ip": null,
"id": 1,
"instance_id": null,
"ip": "10.10.10.1",
"pool": "nova"
},
{
"fixed_ip": null,
"id": 2,
"instance_id": null,
"ip": "10.10.10.2",
"pool": "nova"
}
]
}
This operation does not accept a request body.
Allocates a new floating IP address to a tenant or account.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| pool (Optional) | plain | String |
Pool to allocate IP address from. Default pool is used, if not specified.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the |
{
"pool": "nova"
}
{
"floating_ip": {
"fixed_ip": null,
"id": 1,
"instance_id": null,
"ip": "10.10.10.1",
"pool": "nova"
}
}
Deallocates a specified floating IP address.
You can use this call to deallocate and delete only manually-allocated floating IP addresses. You must manually deallocate auto-allocated floating IP addresses before you can delete them.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the floating IP address. |
This operation does not accept a request body and does not return a response body.
Bulk-creates, deletes, and lists floating IPs. Default pool name is
nova. To view available pools, use the os-floating-ip-pools extension.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"floating_ip_info": [
{
"address": "10.10.10.1",
"instance_uuid": null,
"fixed_ip": null,
"interface": "eth0",
"pool": "nova",
"project_id": null
},
{
"address": "10.10.10.2",
"instance_uuid": null,
"fixed_ip": null,
"interface": "eth0",
"pool": "nova",
"project_id": null
},
{
"address": "10.10.10.3",
"instance_uuid": null,
"fixed_ip": null,
"interface": "eth0",
"pool": "nova",
"project_id": null
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| ip_range | plain | xsd:int |
The range of IP addresses to use for creating floating IPs. |
{
"floating_ips_bulk_create": {
"ip_range": "192.168.1.0/24",
"pool": "nova",
"interface": "eth0"
}
}
{
"floating_ips_bulk_create": {
"interface": "eth0",
"ip_range": "192.168.1.0/24",
"pool": "nova"
}
}
Bulk-deletes floating IPs.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| ip_range | plain | xsd:int |
The range of IP addresses from which to bulk-delete floating IPs. |
{
"ip_range": "192.168.1.0/24"
}
{
"floating_ips_bulk_delete": "192.168.1.0/24"
}
Lists all floating IPs for a specified host.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host_name | URI | xsd:string |
The name of the host of interest to you. |
{
"floating_ip_info": [
{
"address": "10.10.10.3",
"instance_uuid": null,
"fixed_ip": null,
"interface": "eth0",
"pool": "nova",
"project_id": null
}
]
}
This operation does not accept a request body.
Pings all or specified instances and reports which ones are alive.
Run the fping utility to ping all or specified instances and report which ones are alive.
Specify the all_tenants=1 query parameter to ping
instances for all tenants. For example:
GET /os-fping?all_tenants=1
Specify the include and exclude
query parameters to filter the results. For example:
GET /os-fping?all_tenants=1&include=uuid1,uuid2&exclude=uuid3,uuid4
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| all_tenants (Optional) | query | xsd:int |
Specify the |
| include (Optional) | query | xsd:string |
Specify |
| exclude (Optional) | query | xsd:string |
Specify |
{
"servers": [
{
"alive": false,
"id": "1d1aea35-472b-40cf-9337-8eb68480aaa1",
"project_id": "openstack"
}
]
}
Run the fping utility to ping a specified instance and report whether it is alive.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the instance. |
{
"server": {
"alive": false,
"id": "f5e6fd6d-c0a3-4f9e-aabf-d69196b6d11a",
"project_id": "openstack"
}
}
This operation does not accept a request body.
Manages physical hosts.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hosts": [
{
"host_name": "b6e4adbc193d428ea923899d07fb001e",
"service": "conductor",
"zone": "internal"
},
{
"host_name": "09c025b0efc64211bd23fc50fa974cdf",
"service": "compute",
"zone": "nova"
},
{
"host_name": "a942ebfa00064d9d89a9e5a175cb9ba8",
"service": "cert",
"zone": "internal"
},
{
"host_name": "e73ec0bd35c64de4a1adfa8b8969a1f6",
"service": "consoleauth",
"zone": "internal"
},
{
"host_name": "396a8a0a234f476eb05fb9fbc5802ba7",
"service": "network",
"zone": "internal"
},
{
"host_name": "abffda96592c4eacaf4111c28fddee17",
"service": "scheduler",
"zone": "internal"
},
{
"host_name": "a8820f04962a4b4ba9fe2e9540c24094",
"service": "cells",
"zone": "internal"
}
]
}
This operation does not accept a request body.
Enables or puts a specified host in maintenance mode.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host_name | URI | xsd:string |
The name of the host. |
{
"status": "enable",
"maintenance_mode": "disable"
}
{
"host": "65c5d5b7e3bd44308e67fc50f362aee6",
"maintenance_mode": "off_maintenance",
"status": "enabled"
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host_name | URI | xsd:string |
The name of the host. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"host": [
{
"resource": {
"cpu": 1,
"disk_gb": 1028,
"host": "c1a7de0ac9d94e4baceae031d05caae3",
"memory_mb": 8192,
"project": "(total)"
}
},
{
"resource": {
"cpu": 0,
"disk_gb": 0,
"host": "c1a7de0ac9d94e4baceae031d05caae3",
"memory_mb": 512,
"project": "(used_now)"
}
},
{
"resource": {
"cpu": 0,
"disk_gb": 0,
"host": "c1a7de0ac9d94e4baceae031d05caae3",
"memory_mb": 0,
"project": "(used_max)"
}
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host_name | URI | xsd:string |
The name of the host. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"host": "9557750dbc464741a89c907921c1cb31",
"power_action": "reboot"
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host_name | URI | xsd:string |
The name of the host. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"host": "77cfa0002e4d45fe97f185968111b27b",
"power_action": "shutdown"
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host_name | URI | xsd:string |
The name of the host. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"host": "4b392b27930343bbaa27fd5d8328a564",
"power_action": "startup"
}
This operation does not accept a request body.
Displays extra statistical information from the machine that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt).
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisors": [
{
"hypervisor_hostname": "fake-mini",
"id": 1,
"state": "up",
"status": "enabled"
}
]
}
This operation does not accept a request body.
Shows statistics for all hypervisors.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisor_statistics": {
"count": 1,
"current_workload": 0,
"disk_available_least": 0,
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"running_vms": 0,
"vcpus": 1,
"vcpus_used": 0
}
}
This operation does not accept a request body.
Lists hypervisors. Includes PCI device statistics.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisors": [
{
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"state": "up",
"status": "enabled",
"current_workload": 0,
"disk_available_least": 0,
"host_ip": "1.1.1.1",
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"hypervisor_hostname": "fake-mini",
"hypervisor_type": "fake",
"hypervisor_version": 1000,
"id": 1,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"os-pci:pci_stats": [
{
"count": 5,
"key1": "value1",
"keya": "valuea",
"product_id": "1520",
"vendor_id": "8086",
"numa_node": 1
}
],
"running_vms": 0,
"service": {
"host": "043b3cacf6f34c90a7245151fc8ebcda",
"id": 2,
"disabled_reason": null
},
"vcpus": 1,
"vcpus_used": 0
}
]
}
Shows details for a specified hypervisor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisor": {
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"state": "up",
"status": "enabled",
"current_workload": 0,
"disk_available_least": 0,
"host_ip": "1.1.1.1",
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"hypervisor_hostname": "fake-mini",
"hypervisor_type": "fake",
"hypervisor_version": 1000,
"id": 1,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"running_vms": 0,
"service": {
"host": "043b3cacf6f34c90a7245151fc8ebcda",
"id": 2,
"disabled_reason": null
},
"vcpus": 1,
"vcpus_used": 0
}
}
This operation does not accept a request body.
Shows information for a specified hypervisor. Includes PCI device statistics.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisor": {
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"current_workload": 0,
"disk_available_least": 0,
"host_ip": "1.1.1.1",
"state": "up",
"status": "enabled",
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"hypervisor_hostname": "fake-mini",
"hypervisor_type": "fake",
"hypervisor_version": 1000,
"id": 1,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"os-pci:pci_stats": [
{
"count": 5,
"key1": "value1",
"keya": "valuea",
"product_id": "1520",
"vendor_id": "8086",
"numa_node": 1
}
],
"running_vms": 0,
"service": {
"host": "043b3cacf6f34c90a7245151fc8ebcda",
"id": 2,
"disabled_reason": null
},
"vcpus": 1,
"vcpus_used": 0
}
}
Shows details for a specified hypervisor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| hypervisor_id | URI | csapi:UUID |
The ID of the hypervisor. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisor": {
"cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"state": "up",
"status": "enabled",
"current_workload": 0,
"disk_available_least": 0,
"host_ip": "1.1.1.1",
"free_disk_gb": 1028,
"free_ram_mb": 7680,
"hypervisor_hostname": "fake-mini",
"hypervisor_type": "fake",
"hypervisor_version": 1000,
"id": 1,
"local_gb": 1028,
"local_gb_used": 0,
"memory_mb": 8192,
"memory_mb_used": 512,
"running_vms": 0,
"service": {
"host": "043b3cacf6f34c90a7245151fc8ebcda",
"id": 2,
"disabled_reason": null
},
"vcpus": 1,
"vcpus_used": 0
}
}
This operation does not accept a request body.
Shows the uptime for a specified hypervisor.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| hypervisor_id | URI | csapi:UUID |
The ID of the hypervisor. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"hypervisor": {
"hypervisor_hostname": "fake-mini",
"id": 1,
"state": "up",
"status": "enabled",
"uptime": " 08:32:11 up 93 days, 18:25, 12 users, load average: 0.20, 0.12, 0.14"
}
}
This operation does not accept a request body.
Administrator only. Monitors task logs.
Lists usage audits for a specified instance.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"instance_usage_audit_logs": {
"hosts_not_run": [
"f4eb7cfd155f4574967f8b55a7faed75"
],
"log": {},
"num_hosts": 1,
"num_hosts_done": 0,
"num_hosts_not_run": 1,
"num_hosts_running": 0,
"overall_status": "0 of 1 hosts done. 0 errors.",
"period_beginning": "2012-12-01 00:00:00",
"period_ending": "2013-01-01 00:00:00",
"total_errors": 0,
"total_instances": 0
}
}
This operation does not accept a request body.
Lists usage audits that occurred before a specified time.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| before_timestamp | query | xsd:dateTime |
The date and time stamp before which you want to list usage audits. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"instance_usage_audit_log": {
"hosts_not_run": [
"8e33da2b48684ef3ab165444d6a7384c"
],
"log": {},
"num_hosts": 1,
"num_hosts_done": 0,
"num_hosts_not_run": 1,
"num_hosts_running": 0,
"overall_status": "0 of 1 hosts done. 0 errors.",
"period_beginning": "2012-06-01 00:00:00",
"period_ending": "2012-07-01 00:00:00",
"total_errors": 0,
"total_instances": 0
}
}
Shows data on migrations.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers can change
these permissions through the policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"migrations": [
{
"created_at": "2012-10-29T13:42:02.000000",
"dest_compute": "compute2",
"dest_host": "1.2.3.4",
"dest_node": "node2",
"id": 1234,
"instance_uuid": "instance_id_123",
"new_instance_type_id": 2,
"old_instance_type_id": 1,
"source_compute": "compute1",
"source_node": "node1",
"status": "Done",
"updated_at": "2012-10-29T13:42:02.000000"
},
{
"created_at": "2013-10-22T13:42:02.000000",
"dest_compute": "compute20",
"dest_host": "5.6.7.8",
"dest_node": "node20",
"id": 5678,
"instance_uuid": "instance_id_456",
"new_instance_type_id": 6,
"old_instance_type_id": 5,
"source_compute": "compute10",
"source_node": "node10",
"status": "Done",
"updated_at": "2013-10-22T13:42:02.000000"
}
]
}
This operation does not accept a request body.
Creates, lists, shows information for, and deletes networks.
Adds network to a project, disassociates a network from a project, and disassociates a project from a network.
Associates host with and disassociates host from a network.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"network": {
"label": "new net 111",
"cidr": "10.20.105.0/24",
"mtu": 9000,
"dhcp_server": "10.20.105.2",
"enable_dhcp": false,
"share_address": true,
"allowed_start": "10.20.105.10",
"allowed_end": "10.20.105.200"
}
}
{
"network": {
"bridge": null,
"bridge_interface": null,
"broadcast": "10.20.105.255",
"cidr": "10.20.105.0/24",
"cidr_v6": null,
"created_at": null,
"deleted": null,
"deleted_at": null,
"dhcp_server": "10.20.105.2",
"dhcp_start": "10.20.105.2",
"dns1": null,
"dns2": null,
"enable_dhcp": false,
"gateway": "10.20.105.1",
"gateway_v6": null,
"host": null,
"id": "d7a17c0c-457e-4ab4-a99c-4fa1762f5359",
"injected": null,
"label": "new net 111",
"mtu": 9000,
"multi_host": null,
"netmask": "255.255.255.0",
"netmask_v6": null,
"priority": null,
"project_id": null,
"rxtx_base": null,
"share_address": true,
"updated_at": null,
"vlan": null,
"vpn_private_address": null,
"vpn_public_address": null,
"vpn_public_port": null
}
}
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"networks": [
{
"bridge": "br100",
"bridge_interface": "eth0",
"broadcast": "10.0.0.7",
"cidr": "10.0.0.0/29",
"cidr_v6": null,
"created_at": "2011-08-15T06:19:19.387525",
"deleted": false,
"deleted_at": null,
"dhcp_server": "10.0.0.1",
"dhcp_start": "10.0.0.3",
"dns1": null,
"dns2": null,
"enable_dhcp": true,
"gateway": "10.0.0.1",
"gateway_v6": null,
"host": "nsokolov-desktop",
"id": "20c8acc0-f747-4d71-a389-46d078ebf047",
"injected": false,
"label": "mynet_0",
"mtu": null,
"multi_host": false,
"netmask": "255.255.255.248",
"netmask_v6": null,
"priority": null,
"project_id": "1234",
"rxtx_base": null,
"share_address": false,
"updated_at": "2011-08-16T09:26:13.048257",
"vlan": 100,
"vpn_private_address": "10.0.0.2",
"vpn_public_address": "127.0.0.1",
"vpn_public_port": 1000
},
{
"bridge": "br101",
"bridge_interface": "eth0",
"broadcast": "10.0.0.15",
"cidr": "10.0.0.10/29",
"cidr_v6": null,
"created_at": "2011-08-15T06:19:19.885495",
"deleted": false,
"deleted_at": null,
"dhcp_server": "10.0.0.9",
"dhcp_start": "10.0.0.11",
"dns1": null,
"dns2": null,
"enable_dhcp": true,
"gateway": "10.0.0.9",
"gateway_v6": null,
"host": null,
"id": "20c8acc0-f747-4d71-a389-46d078ebf000",
"injected": false,
"label": "mynet_1",
"mtu": null,
"multi_host": false,
"netmask": "255.255.255.248",
"netmask_v6": null,
"priority": null,
"project_id": null,
"rxtx_base": null,
"share_address": false,
"updated_at": null,
"vlan": 101,
"vpn_private_address": "10.0.0.10",
"vpn_public_address": null,
"vpn_public_port": 1001
}
]
}
This operation does not accept a request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"id": "1"
}
This operation does not return a response body.
Shows information for a specified network.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
{
"network": {
"bridge": "br100",
"bridge_interface": "eth0",
"broadcast": "10.0.0.7",
"cidr": "10.0.0.0/29",
"cidr_v6": null,
"created_at": "2011-08-15T06:19:19.387525",
"deleted": false,
"deleted_at": null,
"dhcp_server": "10.0.0.1",
"dhcp_start": "10.0.0.3",
"dns1": null,
"dns2": null,
"enable_dhcp": true,
"gateway": "10.0.0.1",
"gateway_v6": null,
"host": "nsokolov-desktop",
"id": "20c8acc0-f747-4d71-a389-46d078ebf047",
"injected": false,
"label": "mynet_0",
"mtu": null,
"multi_host": false,
"netmask": "255.255.255.248",
"netmask_v6": null,
"priority": null,
"project_id": "1234",
"rxtx_base": null,
"share_address": false,
"updated_at": "2011-08-16T09:26:13.048257",
"vlan": 100,
"vpn_private_address": "10.0.0.2",
"vpn_public_address": "127.0.0.1",
"vpn_public_port": 1000
}
}
This operation does not accept a request body.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
This operation does not accept a request body and does not return a response body.
Associates a specified network with a host.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
{
"associate_host": "testHost"
}
This operation does not return a response body.
Disassociates the host from a specified network.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
{
"disassociate_host": null
}
This operation does not return a response body.
Disassociates a specified network from a project so that the network can be reused.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
{
"disassociate": null
}
This operation does not return a response body.
Disassociates the project from a specified network.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
{
"disassociate_project": null
}
This operation does not return a response body.
Displays extra statistical information from the machine that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt).
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"pci_devices": [
{
"address": "0000:04:10.0",
"compute_node_id": 1,
"id": 1,
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
},
{
"address": "0000:04:10.1",
"compute_node_id": 1,
"id": 2,
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
}
]
}
Lists PCI devices with extra information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"pci_devices": [
{
"address": "0000:04:10.0",
"compute_node_id": 1,
"dev_id": "pci_0000_04_10_0",
"dev_type": "type-VF",
"extra_info": {
"key1": "value1",
"key2": "value2"
},
"id": 1,
"server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1",
"label": "label_8086_1520",
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
},
{
"address": "0000:04:10.1",
"compute_node_id": 1,
"dev_id": "pci_0000_04_10_1",
"dev_type": "type-VF",
"extra_info": {
"key3": "value3",
"key4": "value4"
},
"id": 2,
"server_uuid": "d5b446a6-a1b4-4d01-b4f0-eac37b3a62fc",
"label": "label_8086_1520",
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
}
]
}
Shows information for a specified PCI device. Includes extra information.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| pci_id | URI | csapi:UUID |
The ID of the PCI device. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"pci_device": {
"address": "0000:04:10.0",
"compute_node_id": 1,
"dev_id": "pci_0000_04_10_0",
"dev_type": "type-VF",
"extra_info": {
"key1": "value1",
"key2": "value2"
},
"id": 1,
"server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1",
"label": "label_8086_1520",
"product_id": "1520",
"status": "available",
"vendor_id": "8086"
}
}
Provides quota classes management support.
Shows the quota for a specified class.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| class_id | URI | csapi:UUID |
The ID of the quota class. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"quota_class_set": {
"cores": 20,
"fixed_ips": -1,
"floating_ips": 10,
"id": "test_class",
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 10,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10
}
}
This operation does not accept a request body.
Updates quota for a specified class.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| class_id | URI | csapi:UUID |
The ID of the quota class. |
{
"quota_class_set": {
"instances": 50,
"cores": 50,
"ram": 51200,
"floating_ips": 10,
"metadata_items": 128,
"injected_files": 5,
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"security_groups": 10,
"security_group_rules": 20,
"key_pairs": 100
}
}
{
"quota_class_set": {
"cores": 50,
"fixed_ips": -1,
"floating_ips": 10,
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 50,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10
}
}
Permits administrators, depending on policy settings, to view quotas for a project and view and update default quotas.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
This operation does not accept a request body and does not return a response body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"quota_set": {
"force": "True",
"instances": 45
}
}
{
"quota_set": {
"cores": 20,
"fixed_ips": -1,
"floating_ips": 10,
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 45,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10,
"server_groups": 10,
"server_group_members": 10
}
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"quota_set": {
"security_groups": 45
}
}
{
"quota_set": {
"cores": 20,
"fixed_ips": -1,
"floating_ips": 10,
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 10,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 45,
"server_groups": 10,
"server_group_members": 10
}
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"quota_set": {
"cores": 20,
"fixed_ips": -1,
"floating_ips": 10,
"id": "fake_tenant",
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 10,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10,
"server_groups": 10,
"server_group_members": 10
}
}
This operation does not accept a request body.
Lists quotas with details for a tenant.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"quota_set": {
"cores": 20,
"fixed_ips": -1,
"floating_ips": 10,
"id": "fake_tenant",
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 10,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10,
"server_groups": 10,
"server_group_members": 10
}
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| user_id (Optional) | query | xsd:string |
Specify the user in the
|
{
"quota_set": {
"force": "True",
"instances": 9
}
}
{
"quota_set": {
"cores": 20,
"fixed_ips": -1,
"floating_ips": 10,
"injected_file_content_bytes": 10240,
"injected_file_path_bytes": 255,
"injected_files": 5,
"instances": 9,
"key_pairs": 100,
"metadata_items": 128,
"ram": 51200,
"security_group_rules": 20,
"security_groups": 10,
"server_groups": 10,
"server_group_members": 10
}
}
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| user_id (Optional) | query | xsd:string |
Specify the user in the
|
This operation does not accept a request body and does not return a response body.
Creates a server with scheduler hints that are passed directly to the scheduler.
Creates a server with scheduler hints that are passed directly to the scheduler.
The os:scheduler_hints parameter can be set at
boot time. For details, see Scheduling.
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_group | query | xsd:string |
The name of the security group. If blank, the server is created in the "default" security group. |
| user_data (Optional) | query | xsd:string |
Configuration information or scripts to use upon launch. Must be Base64 encoded. |
| availability_zone (Optional) | query | xsd:string |
The availability zone in which to launch the server. |
| server | plain | String |
Server. |
| imageRef | plain | xsd:string |
The image reference for the desired image for your server instance. Specify as an ID or full URL. |
| flavorRef | plain | xsd:string |
The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL. |
| name | plain | xsd:string |
The name for your created server. |
| metadata (Optional) | plain | xsd:string |
Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. |
| personality (Optional) | plain | xsd:string |
File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data. |
| os:scheduler_hints | plain | xsd:dict |
The dictionary of data to send to the scheduler.
Alternatively, you can specify |
{
"server": {
"name": "new-server-test",
"imageRef": "http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"flavorRef": "http://openstack.example.com/openstack/flavors/1"
},
"os:scheduler_hints": {
"same_host": "48e6a9f6-30af-47e0-bc04-acaed113bb4e"
}
}
{
"server": {
"adminPass": "erQXgJ8NBDD4",
"id": "4c8b1df3-46f7-4555-98d8-cdb869aaf9ad",
"links": [
{
"href": "http://openstack.example.com/v2.1/servers/4c8b1df3-46f7-4555-98d8-cdb869aaf9ad",
"rel": "self"
},
{
"href": "http://openstack.example.com/servers/4c8b1df3-46f7-4555-98d8-cdb869aaf9ad",
"rel": "bookmark"
}
]
}
}
Lists, shows information for, creates, and deletes security groups.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_groups | plain | xsd:string |
Security groups object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | csapi:UUID |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A security group rules object. |
| tenant_id | plain | xsd:string |
The tenant. |
{
"security_groups": [
{
"description": "default",
"id": "3fb26eb3-581b-4420-9963-b0879a026506",
"name": "default",
"rules": [],
"tenant_id": "openstack"
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| security_group | plain | xsd:string |
Specify the |
| name | plain | xsd:string |
The security group name. |
| description (Optional) | plain | xsd:string |
Security group description. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_group | plain | xsd:string |
Security group object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | csapi:UUID |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A security group rules object. |
| tenant_id | plain | xsd:string |
The tenant. |
{
"security_group": {
"name": "test",
"description": "test"
}
}
{
"security_group": {
"description": "test",
"id": "de3ff110-46b2-4ace-bb76-a2e1ed741b95",
"name": "test",
"rules": [],
"tenant_id": "openstack"
}
}
Shows information for a specified security group.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| security_group_id | URI | csapi:UUID |
The ID of the security group. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_group | plain | xsd:string |
Security group object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | csapi:UUID |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A security group rules object. |
| tenant_id | plain | xsd:string |
The tenant. |
{
"security_group": {
"description": "default",
"id": "de3ff110-46b2-4ace-bb76-a2e1ed741b95",
"name": "default",
"rules": [],
"tenant_id": "openstack"
}
}
This operation does not accept a request body.
Updates a security group.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| security_group_id | URI | csapi:UUID |
The ID of the security group. |
| name | plain | xsd:string |
The security group name. |
| description (Optional) | plain | xsd:string |
Security group description. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_group | plain | xsd:string |
Security group object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | csapi:UUID |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A security group rules object. |
| tenant_id | plain | xsd:string |
The tenant. |
{
"security_group": {
"name": "mysecgroup",
"description": "my security group"
}
}
{
"security_group": {
"rules": [],
"tenant_id": "a52cdb9cc7854a39a23d3af73a40899e",
"id": "01fbade5-b664-42f6-83ae-4e214f4263fa",
"name": "mysecgroup",
"description": "my security group"
}
}
Deletes a specified security group.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| security_group_id | URI | csapi:UUID |
The ID of the security group. |
This operation does not accept a request body and does not return a response body.
Lists security groups for a specified server.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| server_id | URI | csapi:UUID |
The UUID for the server. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_groups | plain | xsd:string |
Security groups object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | csapi:UUID |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A security group rules object. |
| tenant_id | plain | xsd:string |
The tenant. |
{
"security_groups": [
{
"description": "default",
"id": "3fb26eb3-581b-4420-9963-b0879a026506",
"name": "default",
"rules": [],
"tenant_id": "openstack"
}
]
}
This operation does not accept a request body.
Lists, shows information for, and creates default security group rules.
Lists default security group rules.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The unique identifier of the tenant or account. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| from_port | plain | xsd:int |
Port at start of range. |
| id | plain | csapi:UUID |
Security group ID. |
| ip_protocol | plain | xsd:string |
The IP protocol: ICMP, TCP, or UDP. |
| ip_range | plain | xsd:string |
An IP range object. |
| cidr | plain | xsd:string |
The CIDR for address range. |
| to_port | plain | xsd:int |
Port at end of range. |
{
"security_group_default_rules": [
{
"from_port": 80,
"id": 1,
"ip_protocol": "TCP",
"ip_range": {
"cidr": "10.10.10.0/24"
},
"to_port": 80
}
]
}
This operation does not accept a request body.
Creates a default security group rule.
You must specify an IP protocol (ip_protocol)
value if you specify a source (from_port) or
destination (to_port) port value. Otherwise, the
operation returns the Bad request (400)
Source/destination port requires a protocol error.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The unique identifier of the tenant or account. |
| id | plain | csapi:UUID |
Security group name or ID. |
| ip_protocol | plain | xsd:string |
The IP protocol: ICMP, TCP, or UDP. |
| from_port | plain | xsd:int |
Port at start of range. |
| to_port | plain | xsd:int |
Port at end of range. |
| cidr | plain | xsd:string |
The CIDR for address range. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| from_port | plain | xsd:int |
Port at start of range. |
| id | plain | csapi:UUID |
Security group ID. |
| ip_protocol | plain | xsd:string |
The IP protocol: ICMP, TCP, or UDP. |
| ip_range | plain | xsd:string |
An IP range object. |
| cidr | plain | xsd:string |
The CIDR for address range. |
| to_port | plain | xsd:int |
Port at end of range. |
{
"security_group_default_rule": {
"ip_protocol": "TCP",
"from_port": "80",
"to_port": "80",
"cidr": "10.10.10.0/24"
}
}
{
"security_group_default_rule": {
"from_port": 80,
"id": 1,
"ip_protocol": "TCP",
"ip_range": {
"cidr": "10.10.10.0/24"
},
"to_port": 80
}
}
Shows information for a specified security group rule.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The unique identifier of the tenant or account. |
| security_group_default_rule_id | URI | csapi:uuid |
The unique identifier of the security group rule. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| from_port | plain | xsd:int |
Port at start of range. |
| id | plain | csapi:UUID |
Security group ID. |
| ip_protocol | plain | xsd:string |
The IP protocol: ICMP, TCP, or UDP. |
| ip_range | plain | xsd:string |
An IP range object. |
| cidr | plain | xsd:string |
The CIDR for address range. |
| to_port | plain | xsd:int |
Port at end of range. |
{
"security_group_default_rule": {
"from_port": 80,
"id": 1,
"ip_protocol": "TCP",
"ip_range": {
"cidr": "10.10.10.0/24"
},
"to_port": 80
}
}
This operation does not accept a request body.
Deletes a specified security group rule.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The unique identifier of the tenant or account. |
| security_group_default_rule_id | URI | csapi:uuid |
The unique identifier of the security group rule. |
This operation does not accept a request body and does not return a response body.
Creates and deletes security group rules.
Creates a rule for a specified security group.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID of the tenant. |
| security_group_rule | plain | xsd:dict |
A |
| parent_group_id | plain | csapi:UUID |
Security group ID. |
| ip_protocol | plain | xsd:string |
The IP protocol: ICMP, TCP, or UDP. |
| from_port | plain | xsd:int |
Port at start of range. |
| to_port | plain | xsd:int |
Port at end of range. |
| cidr | plain | xsd:string |
The CIDR for address range. |
| group_id (Optional) | plain | csapi:UUID |
Source security group ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_group_rule | plain | csapi:UUID |
A |
| ip_protocol | plain | xsd:string |
The IP protocol: ICMP, TCP, or UDP. |
| from_port | plain | xsd:int |
Port at start of range. |
| to_port | plain | xsd:int |
Port at end of range. |
| ip_range | plain | xsd:string |
An |
| cidr | plain | xsd:string |
The CIDR for address range. |
| id | plain | xsd:int |
The security group ID. |
| group | plain | xsd:string |
A |
| tenant_id | plain | csapi:UUID |
The ID of the tenant who owns the source security group. |
| name | plain | xsd:string |
The source security group name. |
{
"security_group_rule": {
"from_port": "443",
"ip_protocol": "tcp",
"to_port": "443",
"cidr": "0.0.0.0/0",
"parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb"
}
}
{
"security_group_rule": {
"id": "2d021cf1-ce4b-4292-994f-7a785d62a144",
"ip_range": {
"cidr": "0.0.0.0/0"
},
"parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb",
"to_port": 443,
"ip_protocol": "tcp",
"group": {},
"from_port": 443
}
}
Deletes a specified security group rule.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | xsd:string |
The ID of the tenant. |
| security_group_rule_id | URI | csapi:uuid |
The ID of the security group rule. |
This operation does not accept a request body and does not return a response body.
Executes external events.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| events | plain | xsd:dict |
Specify the |
| name | plain | xsd:string |
The event name. Valid values are
|
| tag (Optional) | plain | xsd:string |
A string value that identifies the event. |
| server_uuid | plain | xsd:string |
The ID of the server that is associated with the event. |
| status | plain | xsd:string |
The event status. Valid values are
|
| Parameter | Style | Type | Description |
|---|---|---|---|
| code | plain | xsd:string |
The HTTP status code that pertains to the individual event. |
{
"events": [
{
"name": "test-event",
"tag": "foo",
"status": "completed",
"server_uuid": "3df201cf-2451-44f2-8d25-a4ca826fc1f3"
}
]
}
{
"events": [
{
"code": 200,
"name": "network-changed",
"server_uuid": "ff1df7b2-6772-45fd-9326-c0a3b05591c2",
"status": "completed",
"tag": "foo"
}
]
}
Lists, shows information for, creates, and deletes server groups.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| server_groups | plain | xsd:string |
A |
| id | plain | csapi:uuid |
The ID for the server group. |
| name | plain | xsd:string |
The name of the server group. |
| policies | plain | xsd:dict |
A list of policies associated with the server group. |
| members | plain | xsd:dict |
A list of members in the server group. |
| metadata | plain | xsd:string |
Associated metadata key-and-value pairs. |
{
"server_groups": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "test",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {}
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| name | plain | xsd:string |
The server group name. A non-empty string with no leading or trailing spaces. Maximum length is 255 characters. |
| policies (Optional) | plain | xsd:dict |
A list of one or more policy names to associate with the server group. The list must contain at least one policy name. Each policy name must be a non-empty string with no leading or trailing spaces. Maximum length is 255 characters. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_groups | plain | xsd:string |
Security groups object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | xsd:int |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A rules object. |
{
"server_group": {
"name": "test",
"policies": [
"anti-affinity"
]
}
}
{
"server_group": {
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"name": "test",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {}
}
}
Shows details for a specified server group.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| ServerGroup_id | URI | String |
The server group ID. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| security_groups | plain | xsd:string |
Security groups object. |
| description | plain | xsd:string |
Security group description. |
| id | plain | xsd:int |
The security group ID. |
| name | plain | xsd:string |
The security group name. |
| rules | plain | xsd:string |
A rules object. |
{
"server_group": {
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"name": "test",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {}
}
}
This operation does not accept a request body.
Deletes a specified server group.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| ServerGroup_id | URI | String |
The server group ID. |
This operation does not accept a request body and does not return a response body.
Lists, enables, disables, and deletes Compute services in all hosts.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"services": [
{
"id": 1,
"binary": "nova-scheduler",
"disabled_reason": "test1",
"host": "host1",
"state": "up",
"status": "disabled",
"updated_at": "2012-10-29T13:42:02.000000",
"zone": "internal"
},
{
"id": 2,
"binary": "nova-compute",
"disabled_reason": "test2",
"host": "host1",
"state": "up",
"status": "disabled",
"updated_at": "2012-10-29T13:42:05.000000",
"zone": "nova"
},
{
"id": 3,
"binary": "nova-scheduler",
"disabled_reason": null,
"host": "host2",
"state": "down",
"status": "enabled",
"updated_at": "2012-09-19T06:55:34.000000",
"zone": "internal"
},
{
"id": 4,
"binary": "nova-compute",
"disabled_reason": "test4",
"host": "host2",
"state": "down",
"status": "disabled",
"updated_at": "2012-09-18T08:03:38.000000",
"zone": "nova"
}
]
}
This operation does not accept a request body.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"host": "host1",
"binary": "nova-compute"
}
This operation does not return a response body.
Enables scheduling for a service.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"host": "host1",
"binary": "nova-compute"
}
{
"service": {
"binary": "nova-compute",
"host": "host1",
"status": "enabled"
}
}
Disables scheduling for a service.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"host": "host1",
"binary": "nova-compute"
}
{
"service": {
"binary": "nova-compute",
"host": "host1",
"status": "disabled"
}
}
Logs information to the service table about why a service was disabled.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| host | plain | xsd:string |
The host name. |
| binary | plain | xsd:string |
The service name. |
| disabled_reason | plain | xsd:string |
The reason the service was disabled. |
{
"host": "host1",
"binary": "nova-compute",
"disabled_reason": "test2"
}
{
"service": {
"binary": "nova-compute",
"disabled_reason": "test2",
"host": "host1",
"status": "disabled"
}
}
Lists disabled services. If information exists, includes reasons why services were disabled.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"services": [
{
"id": 1,
"binary": "nova-scheduler",
"disabled_reason": "test1",
"host": "host1",
"state": "up",
"status": "disabled",
"updated_at": "2012-10-29T13:42:02.000000",
"zone": "internal"
},
{
"id": 2,
"binary": "nova-compute",
"disabled_reason": "test2",
"host": "host1",
"state": "up",
"status": "disabled",
"updated_at": "2012-10-29T13:42:05.000000",
"zone": "nova"
},
{
"id": 3,
"binary": "nova-scheduler",
"disabled_reason": null,
"host": "host2",
"state": "down",
"status": "enabled",
"updated_at": "2012-09-19T06:55:34.000000",
"zone": "internal"
},
{
"id": 4,
"binary": "nova-compute",
"disabled_reason": "test4",
"host": "host2",
"state": "down",
"status": "disabled",
"updated_at": "2012-09-18T08:03:38.000000",
"zone": "nova"
}
]
}
This operation does not accept a request body.
Reports usage statistics on compute and storage resources.
Lists usage information for all tenants.
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"tenant_usages": [
{
"start": "2012-10-08T21:10:44.587336",
"stop": "2012-10-08T22:10:44.587336",
"tenant_id": "openstack",
"total_hours": 1.0,
"total_local_gb_usage": 1.0,
"total_memory_mb_usage": 512.0,
"total_vcpus_usage": 1.0
}
]
}
Shows usage details for a specified tenant.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| Parameter | Style | Type | Description |
|---|---|---|---|
| X-OpenStack-Request-ID (Optional) | header | xsd:string |
Returns a unique request ID that provides tracking for the request. Provider must configure middleware to provide the request ID. |
{
"tenant_usage": {
"server_usages": [
{
"ended_at": null,
"flavor": "m1.tiny",
"hours": 1.0,
"instance_id": "1f1deceb-17b5-4c04-84c7-e0d4499c8fe0",
"local_gb": 1,
"memory_mb": 512,
"name": "new-server-test",
"started_at": "2012-10-08T20:10:44.541277",
"state": "active",
"tenant_id": "openstack",
"uptime": 3600,
"vcpus": 1
}
],
"start": "2012-10-08T20:10:44.587336",
"stop": "2012-10-08T21:10:44.587336",
"tenant_id": "openstack",
"total_hours": 1.0,
"total_local_gb_usage": 1.0,
"total_memory_mb_usage": 512.0,
"total_vcpus_usage": 1.0
}
}
Creates, lists, shows information for, and deletes project networks.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"network": {
"label": "public",
"cidr": "172.0.0.0/24",
"vlan_start": 1,
"num_networks": 1,
"network_size": 255
}
}
{
"network": {
"cidr": "172.0.0.0/24",
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"label": "public"
}
}
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
{
"networks": [
{
"cidr": "10.0.0.0/29",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"label": "test_0"
},
{
"cidr": "10.0.0.8/29",
"id": "616fb98f-46ca-475e-917e-2563e5a8cd20",
"label": "test_1"
}
]
}
This operation does not accept a request body.
Shows information for a specified project network.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
{
"network": {
"cidr": "172.0.0.0/24",
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"label": "public"
}
}
This operation does not accept a request body.
Deletes a specified project network.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud
providers can change these permissions through the
policy.json file.
| Parameter | Style | Type | Description |
|---|---|---|---|
| tenant_id | URI | csapi:UUID |
The tenant ID in a multi-tenancy cloud. |
| id | URI | csapi:UUID |
The ID of the network. |
This operation does not accept a request body and does not return a response body.