diff --git a/api-ref/src/docbkx/ch_compute-v2.1.xml b/api-ref/src/docbkx/ch_compute-v2.1.xml index 305dbf03c..2da058651 100644 --- a/api-ref/src/docbkx/ch_compute-v2.1.xml +++ b/api-ref/src/docbkx/ch_compute-v2.1.xml @@ -12,65 +12,70 @@ version="5.0-extension RackBook-2.0" xml:id="compute-v2.1" role="api-reference"> - Compute API (CURRENT) - + Compute API (CURRENT) + Effective in the OpenStack Kilo release, XML support in requests and responses was removed for the Compute API. - - + + This documentation supports the API v2.1 base version. If all extensions are enabled, the Compute API v1.1 and v2.0 requests and responses match the API v2.1 requests and responses. - - + + Each API version lists its required extensions for the full request and responses to be available. API v2.1 must enable all extensions all the time. It uses micro-version headers to expose any additional functionality. - - - This page lists the Compute API operations in the following order: - - - - Versions - - - - - Servers - - - - - Flavors - - - - - Keypairs - - - - - Limits - - - - - Extensions in alphabetical order by resource - - - -
+ + + This page lists the Compute API operations in the following order: + + + + Versions + + + + + Servers + + + + + Flavors + + + + + Images + + + + + Keypairs + + + + + Limits + + + + + Extensions in alphabetical order by resource + + + +
API versions Lists information for all API versions. @@ -81,8 +86,8 @@ -
-
+
+
Servers Lists, creates, gets details for, updates, and deletes servers. Passwords @@ -212,8 +217,8 @@ -
-
+
+
Servers multiple create (servers) Creates one or more servers with an optional reservation ID. The @@ -223,28 +228,63 @@ -
-
+
+
Servers actions (servers, action) - Performs actions on a server. Specify the action in the request body. + Performs actions on a server. Specify the action in the request body. - -
-
- Servers action (servers, os-server-actions) - - 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. - - -
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
Servers admin actions (servers, action) Administrators only. Performs actions on a server. Specify the action @@ -253,97 +293,8 @@ -
-
- Servers admin password (servers, action) - - Enables users with the administrative role or the owner of the server - to change the password of the administrative user. - - -
-
- Servers console output (servers, action) - - Gets console output for a server instance. - - -
-
- Servers multiple fixed IP support (servers, action) - - Adds or removes fixed IP addresses from an instance. - - -
-
- Servers remote console (servers, action) - - Provides interactive console support. - - -
-
- Servers shelve (servers, action) - - Shelves 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. - - -
-
- Servers deferred delete (servers, action) - - Force-deletes a server or restores a soft-deleted server. - - -
-
- Servers evacuate (servers, action) - - Evacuates servers. - - - Specify the evacuate action in the request body. - - -
-
+
+
Servers diagnostics (servers, diagnostics) Gets the usage data for a server. @@ -351,8 +302,8 @@ -
-
+
+
Servers IPs (servers, ips) Lists the IP addresses assigned to an instance or shows details for @@ -361,8 +312,8 @@ -
-
+
+
Server metadata (servers, metadata) Lists metadata, creates or replaces one or more metadata @@ -375,18 +326,19 @@ -
-
- Servers configuration drive (servers, os-config-drive) +
+
+ Servers list actions (servers, os-server-actions) - Shows server details including configuration drive information for a - specified server ID or user. + 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. -
-
+
+
Servers password (servers, os-server-password) Gets the encrypted administrative password set through the metadata @@ -395,29 +347,8 @@ -
-
- Servers usage (servers, os-server-usage) - - 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. - - - To hide addresses information for instances in a - specified state, set the - osapi_hide_server_address_states configuration option. - Set this option to a valid VM state in the nova.conf - configuration file. - - -
-
+
+
Servers virtual interfaces (servers, os-virtual-interfaces) Lists virtual interfaces for a specified server instance. @@ -425,8 +356,8 @@ -
-
+
+
Flavors with extended attributes (flavors) Shows information about flavors. @@ -434,8 +365,8 @@ -
-
+
+
Flavors access (flavors, os-flavor-access, action) Provides flavor access support. @@ -456,8 +387,8 @@ -
-
+
+
Flavors extra-specs (flavors, os-flavor-extra-specs) Lists, creates, deletes, and updates the extra-specs or keys for a @@ -466,8 +397,8 @@ -
-
+
+
Flavors manage (flavors, os-flavor-manage) Creates and deletes flavors. @@ -475,33 +406,8 @@ -
-
- Keypairs (keypairs) - Generates, imports, and deletes SSH keys. - -
-
- Limits (limits) - - Shows all global and rate limit information. - - -
-
- Extensions (extensions) - - Available extensions. - - -
-
+
+
Images Lists, gets details for, and deletes images. Also sets, lists, @@ -531,7 +437,7 @@
-
+
Image metadata Shows details for, sets, updates, and deletes image metadata or metadata items. @@ -548,6 +454,31 @@
+
+ Keypairs (keypairs) + Generates, imports, and deletes SSH keys. + +
+
+ Limits (limits) + + Shows all global and rate limit information. + + +
+
+ Extensions (extensions) + + Available extensions. + + +
Guest agents (os-agents) diff --git a/api-ref/src/wadls/common_project.ent b/api-ref/src/wadls/common_project.ent index 4e5b1cf6c..2072295d1 100644 --- a/api-ref/src/wadls/common_project.ent +++ b/api-ref/src/wadls/common_project.ent @@ -227,6 +227,32 @@ '> + + + + The date and time when the server was updated. + + + The date and time stamp format is ISO 8601: + + CCYY-MM-DDThh:mm:ss±hh:mm + + The ±hh:mm value, if included, is the time zone as an + offset from UTC. + + + For example, 2015-08-27T09:49:58-05:00. + + + The UTC time zone is assumed. + + +'> '> + + + + The date and time when the server, image, or backup was created. + + + The date and time stamp format is ISO 8601: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, 2015-08-27T09:49:58-05:00. + + + The ±hh:mm value, if included, is the time zone as an offset from UTC. + + + If the updated_at date and time stamp is not set, its value is + null. + + +'> - server. + server - - - - Enables metadata injection in a server through a configuration drive. - - - Specify true to enable a configuration drive. Otherwise, - specify false. - - - +&config_driveRequestParameter; '> + + + A server object. + +'> + + + A servers object. + +'> + + + + Indicates whether metadata injection is enabled through a configuration + drive. + + +'> + + + + Enables metadata injection in a server through a configuration drive. + + + Specify true to enable a configuration drive. Otherwise, + specify false. + + +'> '> + + + + + Specify the addFixedIp action in the request body. + + +'> + + + + Specify the attach action in the request body. + + +'> + + + + Specify the changePassword action in the request body. + + +'> + + + + Specify the confirmBackup action in the request body. + + +'> + + + + Specify the confirmResize action in the request body. + + +'> + + + + Specify the createImage action in the request body. + + +'> + + + + Specify the createBackup action in the request body. + + +'> + + + + Specify the forceDeleteServer action in the request body. + + +'> + + + + Specify the injectNetworkInfo action in the request body. + + +'> + + + + Specify the lock action in the request body. + + +'> + + + + Specify the migrate action in the request body. + + +'> + + + + Specify the os-getConsoleOutput + action in the request body. + + +'> + + + + Specify the get_vnc_console + action in the request body. + + +'> + + + + Specify the get_spice_console + action in the request body. + + +'> + + + + Specify the os-migrateLive action in the request body. + + +'> + + + + Specify the os-resetState action in the request body. + + +'> + + + + Specify the os-start action in the request body. + + +'> + + + + Specify the os-stop action in the request body. + + +'> + + + + Specify the pause action in the request body. + + +'> + + + + Specify the reboot action in the request body. + + +'> '> + + + + Specify the remove_fixed_ip action in the request body. + + +'> + + + + Specify the rescue action in the request body. + + +'> + + + + Specify the resetNetworkServer action in the request body. + + +'> + + + + Specify the resize action in the request body. + + +'> + + + + Specify the restore action in the request body. + + +'> + + + + Specify the resume action in the request body. + + +'> + + + + Specify the revertResize action in the request body. + + +'> + + + + Specify the shelve action in the request body. + + +'> + + + + Specify the shelveOffload + action in the request body. + + +'> + + + + Specify the suspend action in the request body. + + +'> + + + + Specify the unlock action in the request body. + + +'> + + + + Specify the unrescue action in the request body. + + +'> + + + + Specify the unshelve action in the request body. + + +'> + + + + Specify the unpause action in the request body. + + +'> @@ -625,6 +1071,275 @@ Server links. '> + + + + The UUID for the host. + + +'> + + + + The UUID for the server. + + +'> + + + The image ID and links for the image + for your server instance. + + +'> + + + The flavor ID and links for the flavor + for your server instance. A flavor is a combination of memory, + disk size, and CPUs. + + +'> + + + + Name of associated key pair, if any. + + +'> + + + Server links. + +'> + + + Associated metadata key-and-value pairs. + +'> + + + The server name. + +'> + + + Disk configuration, which is AUTO or + MANUAL. + +'> + + + The availability zone. + +'> + + + The host name. + +'> + + + The hypervisor host name. + +'> + + + The instance name. + +'> + + + The power state of the instance. + +'> + + + The task state of the instance. + +'> + + + The VM state. + +'> + + + Attached volumes, if any. + +'> + + + + The date and time when the server was launched. + + + The date and time stamp format is ISO 8601: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, 2015-08-27T09:49:58-05:00. + + + The ±hh:mm value, if included, is the time zone as an offset from UTC. + + + If the deleted_at date and time stamp is not set, its value is + null. + + +'> + + + + The date and time when the server was deleted. + + + The date and time stamp format is ISO 8601: + + CCYY-MM-DDThh:mm:ss±hh:mm + + For example, 2015-08-27T09:49:58-05:00. + + + The ±hh:mm value, if included, is the time zone as an offset from UTC. + + + If the deleted_at date and time stamp is not set, its value is + null. + + +'> + + + A percentage value of the build progress. + +'> + + + The server status. + +'> + + + The tenant ID in a multi-tenancy cloud. + +'> + + + + The user ID of the user who owns the server. + + +'> - The addresses for the server. If osapi_hide_server_address_states is set, - addresses information is hidden for any server in the specified state. By default, + The addresses for the server. + + + If osapi_hide_server_address_states is set, addresses + information is hidden for any server in the specified state. By default, servers in BUILDING state hide their addresses information. @@ -1587,48 +2305,8 @@ '> - - - - - Specify the shelve action in the request body. - - -'> - - - - Specify the shelveOffload - action in the request body. - - - '> - - - - Specify the unshelve action in the request body. - - -'> - - + '> + diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-actions-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-actions-v2.1.wadl index 600a6115b..6d82f36c3 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-actions-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-actions-v2.1.wadl @@ -20,19 +20,19 @@ &serverIdRequestParameter; - - - - - - - - - - - - - + + + + + + + + + + + + + @@ -42,13 +42,15 @@ - - + - Changes the admin password. + + Changes the administrative password for a specified server. + - Specify the changePassword action in - the request body. + Specify the changePassword action in the request + body. Policy defaults enable only users with the administrative role @@ -64,17 +66,20 @@ href="../api_samples/os-admin-password/admin-password-change-password.json" /> + &changePasswordActionRequestParameter; - - + - Backs up a server instance. + + Backs up a specified server instance. + - Specify the createBackup action in - the request body. + Specify the createBackup action in the request + body. Policy defaults enable only users with the administrative role @@ -90,20 +95,22 @@ href="../api_samples/os-create-backup/create-backup-req.json" /> + &createBackupActionRequestParameter; - - + - Injects network information into a - server. - - Specify the injectNetworkInfo action in - the request 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. @@ -117,18 +124,21 @@ href="../api_samples/os-admin-actions/admin-actions-inject-network-info.json" /> + &injectNetworkInfoActionRequestParameter; - - + - Live-migrates a server to a new - host without rebooting. + + Live-migrates a specified server to a new host without + rebooting. + - Specify the os-migrateLive action in - the request body. + Specify the os-migrateLive action in the request + body. Policy defaults enable only users with the administrative role @@ -144,17 +154,19 @@ href="../api_samples/os-migrate-server/live-migrate-server.json" /> + &os-migrateLiveActionRequestParameter; - - + - Locks a server instance. + + Locks a specified server instance. + - Specify the lock action in - the request body. + Specify the lock action in the request body. Policy defaults enable only users with the administrative role @@ -170,18 +182,20 @@ href="../api_samples/os-lock-server/lock-server.json" /> + &lockActionRequestParameter; - - + - Migrates a server to a host. The - scheduler chooses the host. + + Migrates a specified server to a host. The scheduler chooses + the host. + - Specify the migrate action in - the request body. + Specify the migrate action in the request body. Policy defaults enable only users with the administrative role @@ -197,18 +211,18 @@ href="../api_samples/os-migrate-server/migrate-server.json" /> + &migrateActionRequestParameter; - - + - Pauses a server. Changes its status - to PAUSED. + Pauses a specified server. Changes its status + to PAUSED. - Specify the pause action in - the request body. + Specify the pause action in the request body. Policy defaults enable only users with the administrative role @@ -224,17 +238,19 @@ href="../api_samples/os-pause-server/pause-server.json" /> + &pauseActionRequestParameter; - - + - Resets networking on a - server. + + Resets networking on a specified server. + - Specify the resetNetwork action in + Specify the resetNetworkServer action in the request body. @@ -251,14 +267,15 @@ href="../api_samples/os-admin-actions/admin-actions-reset-network.json" /> + &resetNetworkServerActionRequestParameter; - - + - Resets the state of a server to a + Resets the state of a specified server to a specified state. Specify the os-resetState action and the @@ -278,18 +295,20 @@ href="../api_samples/os-admin-actions/admin-actions-reset-server-state.json" /> + &os-resetStateActionRequestParameter; - - + - Resumes a SUSPENDED server and - changes its status to ACTIVE. + + Resumes a suspended server and changes its status to + ACTIVE. + - Specify the resume action in - the request body. + Specify the resume action in the request body. Policy defaults enable only users with the administrative role @@ -305,18 +324,20 @@ href="../api_samples/os-suspend-server/server-resume.json" /> + &resumeActionRequestParameter; - - + - Suspends a server and changes its - status to SUSPENDED. + + Suspends a specified server and changes its status to + SUSPENDED. + - Specify the suspend action in - the request body. + Specify the suspend action in the request body. Policy defaults enable only users with the administrative role @@ -332,17 +353,17 @@ href="../api_samples/os-suspend-server/server-suspend.json" /> + &suspendActionRequestParameter; - - + - Unlocks a server instance. + Unlocks a specified server instance. - Specify the unlock action in - the request body. + Specify the unlock action in the request body. Policy defaults enable only users with the administrative role @@ -358,18 +379,20 @@ href="../api_samples/os-lock-server/unlock-server.json" /> + &unlockActionRequestParameter; - - + - Unpauses a PAUSED server and - changes its status to ACTIVE. + + Unpauses a paused server and changes its status to + ACTIVE. + - Specify the unpause action in - the request body. + Specify the unpause action in the request body. Policy defaults enable only users with the administrative role @@ -385,6 +408,7 @@ href="../api_samples/os-pause-server/unpause-server.json" /> + &unpauseActionRequestParameter; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-password-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-password-v2.1.wadl deleted file mode 100644 index a3d94de6d..000000000 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-admin-password-v2.1.wadl +++ /dev/null @@ -1,60 +0,0 @@ - - - - %common; - - %common_project; -]> - - - - - - &tenantIdRequestParameter; - - - &serverIdRequestParameter; - - - - - - - - - - - - - - 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. - - - - - - - - - - - - diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-compute-2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-compute-2.1.wadl index d6bb7834f..0dbeffc9c 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-compute-2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-compute-2.1.wadl @@ -12,24 +12,23 @@ xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:csapi="http://docs.openstack.org/identity/api/v3" xmlns:xlink="http://www.w3.org/1999/xlink"> - - - - &tenantIdRequestParameter; - - - - - &serverIdRequestParameter; - - - - + + + + &tenantIdRequestParameter; + + + + + &serverIdRequestParameter; + + + - + + @@ -185,66 +184,86 @@ Server status values - ACTIVE. The server is active. + + ACTIVE. The server is active. + - BUILDING. The server has not finished the original build + + BUILDING. The server has not finished the original build process. - DELETED. The server is permanently deleted. - - - ERROR. The server is in error. - - - HARD_REBOOT. The server is hard rebooting. This is equivalent - to pulling the power plug on a physical server, plugging it back in, and - rebooting it. + + DELETED. The server is permanently deleted. - PASSWORD. The password is being reset on the server. + + ERROR. The server is in error. + - PAUSED. In a paused state, the state of the server is + + HARD_REBOOT. The server is hard rebooting. This + is equivalent to pulling the power plug on a physical + server, plugging it back in, and rebooting it. + + + + + PASSWORD. The password is being reset on the server. + + + + + PAUSED. In a paused state, the state of the server is stored in RAM. A paused server continues to run in frozen state. - REBOOT. The server is in a soft reboot state. A reboot + + REBOOT. The server is in a soft reboot state. A reboot command was passed to the operating system. - REBUILD. The server is currently being rebuilt from an + + REBUILD. The server is currently being rebuilt from an image. - RESCUED. The server is in rescue mode. A rescue image + + RESCUED. The server is in rescue mode. A rescue image is running with the original server image attached. - RESIZED. Server is performing the differential copy of data - that changed during its initial copy. Server is down for this stage. + + RESIZED. Server is performing the differential + copy of data that changed during its initial copy. Server is + down for this stage. - REVERT_RESIZE. The resize or migration of a server failed for - some reason. The destination server is being cleaned up and the original - source server is restarting. + + REVERT_RESIZE. The resize or migration of a + server failed for some reason. The destination server is + being cleaned up and the original source server is + restarting. - SOFT_DELETED. The server is marked as deleted but the + + SOFT_DELETED. The server is marked as deleted but the disk images are still available to restore. - STOPPED. The server is powered off and the disk image + + STOPPED. The server is powered off and the disk image still persists. @@ -252,23 +271,25 @@ SUSPENDED. The server is suspended, either by request or necessity. This status appears for only - the following hypervisors: XenServer/XCP, KVM, and ESXi. - Administrative users may suspend an instance if it is - infrequently used or to perform system maintenance. When you - suspend an instance, its VM state is stored on disk, all memory is written - to disk, and the virtual machine is stopped. Suspending an instance is - similar to placing a device in hibernation; memory and vCPUs become - available to create other instances. + the XenServer/XCP, KVM, and ESXi hypervisors. Administrative + users can suspend an instance if it is infrequently used or + to perform system maintenance. When you suspend an instance, + its VM state is stored on disk, all memory is written to + disk, and the virtual machine is stopped. Suspending an + instance is similar to placing a device in hibernation; + memory and vCPUs become available to create other instances. - UNKNOWN. The state of the server is unknown. Contact your - cloud provider. + + UNKNOWN. The state of the server is unknown. + Contact your cloud provider. - VERIFY_RESIZE. System is awaiting confirmation that the - server is operational after a move or resize. + + VERIFY_RESIZE. System is awaiting confirmation + that the server is operational after a move or resize. @@ -301,6 +322,27 @@ your server runs on and can be used to determine this scenario if it is relevant to your application. + + For each server, shows server details including configuration + drive, extended status, and server usage information. + + + The extended status information appears in the + OS-EXT-STS:vm_state, OS-EXT-STS:power_state, and + OS-EXT-STS:task_state attributes. + + + The server usage information appears in the + OS-SRV-USG:launched_at and OS-SRV-USG:terminated_at + attributes. + + + To hide addresses information for instances in a + specified state, set the + osapi_hide_server_address_states configuration + option. Set this option to a valid VM state in the + nova.conf configuration file. + HostId is unique per @@ -319,13 +361,45 @@ + &serversObjectParameter; + &serverResponseParameters; - &commonFaults; + + &commonFaults; - Gets details for a specified server. + + Shows details for a specified server. + + + Includes server details including configuration + drive, extended status, and server usage information. + + + The extended status information appears in the + OS-EXT-STS:vm_state, OS-EXT-STS:power_state, and + OS-EXT-STS:task_state attributes. + + + The server usage information appears in the + OS-SRV-USG:launched_at and OS-SRV-USG:terminated_at + attributes. + + + To hide addresses information for instances in a + specified state, set the + osapi_hide_server_address_states configuration + option. Set this option to a valid VM state in the + nova.conf configuration file. + + + + HostId is unique per + account and is not globally unique. + + Preconditions @@ -339,6 +413,8 @@ &x-compute-request-idHeader; + &serverObjectParameter; + &serverResponseParameters; &commonFaults; &getFaults; @@ -381,7 +457,8 @@ - &commonFaults; &getFaults; &postPutFaults; + + &commonFaults; &getFaults; &postPutFaults; &inProgressFault; @@ -390,20 +467,24 @@ Preconditions - The specified server must exist. + + The specified server must exist. - Anyone can delete a server when the server's + + Anyone can delete a server when the server's status is not locked. - You can delete a server which status is + + You can delete a server which status is not locked. - If the specified server is locked, you need to + + If the specified server is locked, you need to have administrator privileges to delete the server. @@ -411,23 +492,27 @@ Asynchronous postconditions - With correct permissions, you can see the + + With correct permissions, you can see the specified server status as DELETED through API calls. - The port attached to the specified server + + The port attached to the specified server is deleted. - The server is deleted from the list of + + The server is deleted from the list of servers returned by an API calls. - The server managed by OpenStack Compute is + + The server managed by OpenStack Compute is deleted on the compute node. @@ -435,20 +520,23 @@ Troubleshooting - If server status remains in deleting + + If server status remains in deleting or shows another error status, the request failed. Ensure you meet the preconditions then investigate the compute back end. - The request returns the HTTP 409 status code + + The request returns the HTTP 409 status code when the server is locked even if you have a correct permissions. Ensure you meet the preconditions then investigate the server status. - The server managed by OpenStack Compute is not + + The server managed by OpenStack Compute is not deleted from the compute node. diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl deleted file mode 100644 index d3e251c81..000000000 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-config-drive-v2.1.wadl +++ /dev/null @@ -1,65 +0,0 @@ - - - - %common; - - %common_project; -]> - - - - - &tenantIdRequestParameter; - - - &serverIdRequestParameter; - - - - - - - - - - - - - - - Shows details for a specified - server. Includes configuration drive information. - - - - - - &x-openstack-request-idHeader; - - - - - - Lists server details. Includes configuration drive information. - - - - - - &x-openstack-request-idHeader; - - - - diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-console-output-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-console-output-v2.1.wadl index 766fff9e6..fdd8727d1 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-console-output-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-console-output-v2.1.wadl @@ -20,18 +20,18 @@ &serverIdRequestParameter; - + - + + title="Get console output for a server (os-getConsoleOutput action)"> - Gets console output for a server instance. + Gets console output for a specified server instance. Specify the os-getConsoleOutput action in the @@ -47,17 +47,7 @@ href="../api_samples/os-console-output/console-output-post-req.json" /> - - - - Specify the os-getConsoleOutput - action in the request body. - - - + &os-getConsoleOutputActionRequestParameter; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl index 4ad27a12a..7a6aa05d6 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-deferred-delete-v2.1.wadl @@ -20,8 +20,8 @@ &serverIdRequestParameter; - - + + @@ -31,14 +31,14 @@ - - + - Force deletes an instance before deferred cleanup. + Force-deletes a specified server before deferred cleanup. - Specify the forceDelete action in the request body. + Specify the forceDeleteServer action in the request body. Policy defaults enable only users with the administrative role @@ -54,16 +54,17 @@ href="../api_samples/os-deferred-delete/force-delete-post-req.json" /> + &forceDeleteServerActionRequestParameter; - - + - Restores a previously soft-deleted instance. You cannot use - this method to restore deleted instances. + Restores a previously soft-deleted server instance. You cannot + use this method to restore deleted instances. Specify the restore action in the request body. @@ -82,6 +83,7 @@ href="../api_samples/os-deferred-delete/restore-post-req.json" /> + &restoreActionRequestParameter; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl index 049753dd9..4896061e6 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-evacuate-v2.1.wadl @@ -19,7 +19,7 @@ &serverIdRequestParameter; - + @@ -29,11 +29,11 @@ - - + - Evacuates a server from a failed host to a new one. + Evacuates a specified server from a failed host to a new one. Specify the evacuate action in the request body. diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl index b8e540e55..943a3affe 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-multinic-v2.1.wadl @@ -20,8 +20,8 @@ &serverIdRequestParameter; - - + + @@ -31,14 +31,15 @@ - - + - Adds an IP to a specified network - on an instance. + + Adds a fixed IP address to a specified network on a specified server instance. + - Specify the addFixedIp action in the request - body. + Specify the addFixedIp action and the network ID + in the request body. Policy defaults enable only users with the administrative role @@ -53,15 +54,17 @@ href="../api_samples/os-multinic/multinic-add-fixed-ip-req.json" /> + &addFixedIpActionRequestParameter; - - + - Removes an IP from a specified - instance. + Removes a fixed IP address from a specified + server. + Specify the remove_fixed_ip action in the request body. @@ -79,6 +82,7 @@ href="../api_samples/os-multinic/multinic-remove-fixed-ip-req.json" /> + &remove_fixed_ipActionRequestParameter; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl index 83066b3dd..d20520d2b 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-remote-consoles-v2.1.wadl @@ -20,8 +20,8 @@ &serverIdRequestParameter; - - + + @@ -31,10 +31,11 @@ - - + - Gets text console output. + Gets a SPICE console for a specified server. + Specify the get_spice_console action in the request body. @@ -47,6 +48,7 @@ href="../api_samples/os-remote-consoles/get-spice-console-post-req.json" /> + &get_spice_consoleActionRequestParameter; @@ -59,10 +61,11 @@ - - + - Gets text console output for VNC. + Gets a VNC console for a specified server. + Specify the get_vnc_console action in the request body. @@ -75,6 +78,7 @@ href="../api_samples/os-remote-consoles/get-vnc-console-post-req.json" /> + &get_vnc_consoleActionRequestParameter; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl index 0ebf17ede..1fc2b16e2 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-actions-v2.1.wadl @@ -21,17 +21,17 @@ &serverIdRequestParameter; + + + + - - - - - - - - + + + + @@ -41,94 +41,93 @@ - - + + - Reboots the specified server. Specify the reboot - action in the request body. - - - - - - - - - - - &commonFaults; &getFaults; &postPutFaults; - &rebootFaults; &inProgressFault; - - - - Rebuilds the specified server. Specify the - rebuild action in the request body. + Attaches a specified volume to a specified server. - To rebuild the specified server with preservation of the - ephemeral partition, set the preserve_ephemeral - parameter to true. - - - - - - - - &rebuildActionRequestParameter; - &imageRefRequestParameter; - &serverNameRequestParameter; - &adminPassRequestParameter; - &metadataRequestParameter; - &personalityRequestParameter; - &preserve_ephemeralRequestParameter; - - - - - - - - - - &commonFaults; - &getFaults; &postPutFaults; &buildFaults; &inProgressFault; - - - - Resizes the specified server. Specify the resize - action in the request body. + Specify the attach action in the request body. - A successfully resized server shows a - VERIFY_RESIZE status, RESIZED VM - status, and finished migration status. If you set - the auto_confirm option of the Compute service to - True, the Compute service automatically confirms - the resize operation. + If the attach operation succeeds, the volume status + is in-use. 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. + + 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. + + - + + &attachActionRequestParameter; + + The volume ID. + + + + The device name. + + + + The disk bus name. + + + + The device type name. + + - &commonFaults; - &getFaults; &postPutFaults; &buildFaults; &inProgressFault; - - + + + + &commonFaults; + &getFaults; &postPutFaults; &buildFaults; &inProgressFault; + + + - Confirms a pending resize action. Specify the + Confirms a pending resize action for a specified server. + + + Specify the confirmResize action in the request body. @@ -163,59 +162,21 @@ + &confirmResizeActionRequestParameter; - &commonFaults; - &getFaults; &postPutFaults; &buildFaults; &inProgressFault; - - + &commonFaults; + &getFaults; &postPutFaults; &buildFaults; &inProgressFault; + + + - Cancels and reverts a pending resize action. Specify the - revertResize action in the request body. + Creates an image from a specified server. - 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. - - - - - - - - - - - &commonFaults; - &getFaults; &postPutFaults; &buildFaults; &inProgressFault; - - - - Creates an image. Specify the createImage - action in the request body. + Specify the createImage action in the request body. After you make this request, you typically must keep polling @@ -263,194 +224,83 @@ + &createImageActionRequestParameter; - - + - &commonFaults; + &commonFaults; &getFaults; &postPutFaults; &buildFaults; &inProgressFault; - + - 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. - - - - - - - - - - - Specify the - os-start action in the - request 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. - - - - - - - - - - Specify the - os-stop action in the - request body. - - - - - - - + title="Reboot server (reboot action)"> - Attaches a specified volume. Specify the attach - action in the request body. + Reboots a specified server. - If the attach operation succeeds, the volume status - is in-use. + Specify the reboot action in the request body. - 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. - - - + - - The volume ID. - - - - The device name. - - - - The disk bus name. - - - - The device type name. - - + &rebootActionRequestParameter; + + + + &commonFaults; &getFaults; &postPutFaults; + &rebootFaults; &inProgressFault; + + + + Rebuilds a specified server. + + + Specify the rebuild action in the request body. + + + To rebuild the specified server with preservation of the + ephemeral partition, set the preserve_ephemeral + parameter to true. + + + + + + + + &rebuildActionRequestParameter; + &imageRefRequestParameter; + &serverNameRequestParameter; + &adminPassRequestParameter; + &metadataRequestParameter; + &personalityRequestParameter; + &preserve_ephemeralRequestParameter; + + + + + - - - - &commonFaults; - &getFaults; &postPutFaults; &buildFaults; &inProgressFault; - - + &commonFaults; + &getFaults; &postPutFaults; &buildFaults; &inProgressFault; + + title="Rescue server (rescue action)"> - Puts a server in rescue mode and changes its status to + Puts a specified server in rescue mode and changes its status to RESCUE. + + Specify the rescue action in the request body. + If you specify the rescue_image_ref extended attribute, the specified image is used to rescue the instance. @@ -482,17 +332,7 @@ href="../api_samples/os-rescue/server-rescue-req-with-image-ref.json" /> - - - - Specify the rescue action in the - request body. - - - + &rescueActionRequestParameter; - + + title="Resize server (resize action)"> + + Resizes a specified server. + + + Specify the resize action in the request body. + + + A successfully resized server shows a + VERIFY_RESIZE status, RESIZED VM + status, and finished migration status. 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. + + + + + + + + + + &resizeActionRequestParameter; + + + + &commonFaults; &getFaults; &postPutFaults; &buildFaults; &inProgressFault; + + + + + Cancels and reverts a pending resize action for a specified server. + + + 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. + + + + + + + + &revertResizeActionRequestParameter; + + + + &commonFaults; + &getFaults; &postPutFaults; &buildFaults; &inProgressFault; + + + + + Starts a specified stopped server and changes + its status to ACTIVE. + + + Specify the os-start action in the request body. + 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. + + + + + + + + + + &os-startActionRequestParameter; + + + + + + + Stops a running server and changes + its status to SHUTOFF. + + + Specify the os-stop + action in the request body. + 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. + + + + + + + + + &os-stopActionRequestParameter; + + + + + + Unrescues a specified server. Changes status to ACTIVE. + + Specify the unrescue + action in the request body. + Preconditions The specified server must exist. @@ -575,17 +601,7 @@ href="../api_samples/os-rescue/server-unrescue-req.json" /> - - - - Specify the unrescue - action in the request body. - - - + &unrescueActionRequestParameter; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl index 34ef32dc5..acaec692d 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-groups-v2.1.wadl @@ -88,7 +88,7 @@ href="../api_samples/os-server-groups/server-groups-post-resp.json" /> - &serverGroupParameters; + &securityGroupParameters; @@ -149,7 +149,7 @@ href="../api_samples/os-server-groups/server-groups-get-resp.json" /> - &serverGroupParameters; + &securityGroupParameters; diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl deleted file mode 100644 index 489d4c0c0..000000000 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl +++ /dev/null @@ -1,80 +0,0 @@ - - - - %common; - - %common_project; -]> - - - - - &tenantIdRequestParameter; - - - - - - &serverIdRequestParameter; - - - - - - - - - - - - Shows details for a specified - server. Includes server usage information. - - - - - - - &x-openstack-request-idHeader; - &serverListDetailsResponseParameters; - &serverAddressResponseParameters; - - - - - - - Lists servers. Includes server usage details. - - - - - &serverListDetailsParameters; - - - - - - - - &x-openstack-request-idHeader; - &serverListDetailsResponseParameters; - &serverAddressResponseParameters; - - - - diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl index 23b9c0c63..5abc06ca5 100644 --- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl +++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-shelve-v2.1.wadl @@ -20,22 +20,22 @@ &serverIdRequestParameter; - - - + + + - + - Shelves a server. + title="Shelve server (shelve action)"> + Shelves a specified server. - Specify the shelve action in the request - body. + Specify the shelve action in the request + body. All associated data and resources are kept but anything still in @@ -107,18 +107,18 @@ href="../api_samples/os-shelve/os-shelve.json" /> - &shelveAction; + &shelveActionRequestParameter; - + - Removes an instance from the - server. + title="Remove shelved server (shelveOffload action)"> + + Removes a specified shelved server. + - Specify the shelveOffload action in the request - body. + 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 @@ -164,15 +164,14 @@ href="../api_samples/os-shelve/os-shelve-offload.json" /> - &shelveOffloadAction; + &shelveOffloadActionRequestParameter; - + - Restores a shelved server. - + title="Restore shelved server (unshelve action)"> + Restores a shelved server. Specify the unshelve action in the request body. @@ -218,7 +217,7 @@ href="../api_samples/os-shelve/os-unshelve.json" /> - &unshelveAction; + &unshelveActionRequestParameter;