ERROR state if the
- complexity requirements are not met. In this case, a client might
- issue a change password action to reset the server password.
- maxServerMeta absolute limit.
- maxPersonality absolute limit defines
- the maximum number of file path and content pairs that
- you can supply. The compute provider determines this
- value.
- maxPersonalitySize absolute limit is a byte limit
- that applies to all images in the deployment. Providers can set
- additional per-image personality limits.
- chmod 440).
- "return_reservation_id": "True"
- in the request body to request that a reservation ID be returned
- instead of the newly created instance information. With this
- parameter, the response shows only the reservation ID.
- is_public set to false while a
- public flavor has is_public set to true.
- policy.json file authorizes all users to
- view the image size in the OS-EXT-IMG-SIZE:size extended
- attribute.
- nova.
- os-floating-ip-pools
- extension.
- os-server-external-events.
- root.
- dns_entry object.
- dns_entries object.
- public or private.
- ACTIVE.
- BASE, SERVER, or ALL.
- name attribute. If you omit this attribute, the API
- creates the server in the default security group.
- networks object. Required parameter
- when there are mulitple networks defined for the tenant.
- When you do not specify the networks parameter, the server
- attaches to the only network created for the current tenant.
- uuid attribute in a
- networks object.
- port attribute in a
- networks object.
- uuid attribute in a
- networks object. Required if you omit the port
- attribute.
- port attribute in a
- networks object. The port status must be DOWN.
- required if you omit the uuid attribute.
- neutron or nova-networks network.
-
- "block_device_mapping_v2":
- {
- "boot_index": "0",
- "uuid": "ac408821-c95a-448f-9292-73986c790911",
- "source_type": "image",
- "volume_size": "25",
- "destination_type": "volume",
- "delete_on_termination": true
- }
-
- blank,
- snapshot, volume, or image.
- local
- or volume.
- true. Otherwise, specify false.
- ephemeral or swap.
- 0. To
- disable a device from booting, set the boot index to a negative value or
- use the default boot index value, which is None.
- 0 and use the default boot index value, None,
- for any other devices.
- 0.
- OS-SCH-HNT:scheduler_hints
- as the string.
- server object.server objects.
- config_drive. Read more in the
- OpenStack
- End User Guide.
- true to enable a configuration drive. Otherwise,
- specify false.
- true to migrate local disks by using block
- migration. If the source or destination host uses shared storage and
- you set this value to true, the live migration fails.
- true to enable over commit when the destination
- host is checked for available disk space.
- false to disable over commit. This setting affects
- only the libvirt virt driver.
- OS-DCF:diskConfig
- value from the image from which it was created, and an image inherits
- the OS-DCF:diskConfig value from the server from which
- it was created. To override the inherited setting, you can include
- this attribute in the request body of a server create, rebuild, or
- resize request.
- OS-DCF:diskConfig value for an image is
- MANUAL, you cannot create a server from that image and set
- its OS-DCF:diskConfig value to AUTO.
- AUTO. The API builds the server with a single partition
- the size of the target flavor disk. The API automatically adjusts the file
- system to fit the entire partition.
- MANUAL. The API builds the server by using whatever
- partition scheme and file system is in the source image. If the target flavor
- disk is larger, the API does not partition the remaining disk space.
- true to request that the response return a
- reservation ID instead of instance information. Default is
- false.
- enable_instance_password configuration option to
- true. If you set this option to false and you
- try to set the administrative password, the API does not set the
- password and the response shows a null value for the
- adminPass parameter.
- true).
- ?name=bob regular expression returns both bob and bobb. If
- you must match on only bob, you can use a regular expression that
- matches the syntax of the underlying database server that is implemented
- for Compute, such as MySQL or PostgreSQL.
- ACTIVE.
- server object.
- AUTO. The API builds the server with a single
- partition the size of the target flavor disk. The API automatically adjusts
- the file system to fit the entire partition.
- MANUAL. The API builds the server by using the
- partition scheme and file system that is in the source image. If the target
- flavor disk is larger, The API does not partition the remaining disk space.
- UP if nova-compute up.
- UNKNOWN if nova-compute not reported by servicegroup driver.
- DOWN if nova-compute forced down.
- MAINTENANCE if nova-compute is disabled.
- image object might be an empty string when
- you boot the server from a volume.
- AUTO or
- MANUAL.
- 2015-08-27T09:49:58-05:00.
- ±hh:mm value, if included, is the time zone as an offset from UTC.
- deleted_at date and time stamp is not set, its value is
- null.
- 2015-08-27T09:49:58-05:00.
- ±hh:mm value, if included, is the time zone as an offset from UTC.
- deleted_at date and time stamp is not set, its value is
- null.
- ACTIVE.
- ACTIVE.
- created.
- You can specify multiple pairs of sort key and sort direction query
- parameters. If you omit the sort direction in a pair, the API uses the
- natural sorting direction of the server sort_key attribute.
- asc (ascending) or
- desc (descending). Default is desc. You can
- specify multiple pairs of sort key and sort direction query parameters. If
- you omit the sort direction in a pair, the API uses the natural sorting
- direction of the direction of the server sort_key attribute.
- created. You can
- specify multiple pairs of sort key and sort direction query parameters.
- If you omit the sort direction in a pair, the API uses the natural
- sorting direction of the direction of the server sort_key
- attribute.
- asc (ascending) or
- desc (descending). Default is desc. You can
- specify multiple pairs of sort key and sort direction query parameters. If
- you omit the sort direction in a pair, the API uses the natural sorting
- direction of the direction of the server sort_key attribute.
- true) or unlocked
- (false).
- osapi_hide_server_address_states configuration option. By
- default, servers in building state hide their addresses
- information.
- created.
- You can specify multiple pairs of sort key and sort direction query
- parameters. If you omit the sort direction in a pair, the API uses the
- natural sorting direction of the server sort_key attribute.
- asc (ascending) or
- desc (descending). Default is desc. You can
- specify multiple pairs of sort key and sort direction query parameters. If
- you omit the sort direction in a pair, the API uses the natural sorting
- direction of the direction of the server sort_key attribute.
- quota_set object.
- "force": "true". Default is false.
- quota_set object.
- server_groups object.
- virtual_interfaces object.changes-since time. If data has not changed since the
- changes-since time, the call returns an empty list.
- changes-since value specifies a date
- in the last 30 days. Items deleted more than 30 days ago might be
- returned, but it is not guaranteed.
- ±hh:mm value, if included, returns the time zone as an
- offset from UTC.
- 2015-08-27T09:49:58-05:00.
- ACTIVE.
- 100.
- 512.
- snapshot or backup.
- service object.
- service objects.
- true to force down the service. Set to
- false to unset a forced-down service.
- true, the service was forced down.
- up or down.
- enabled or
- disabled.
- extension object.
- extension objects.
- href and rel.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- add_host action in the request body.
- set_metadata action in the request body.
- remove_host action in the request body.
- snapshot object.
- qcow2.
- delete_info
- query parameter to the URI, as follows:
- ACTIVE, PAUSED,
- SHUTOFF, VERIFY_RESIZE, or
- SOFT_DELETED status.
- Not
- Implemented (501) response code.
- Not
- Implemented (501) response code.
- Not
- Implemented (501) response code.
- Not
- Implemented (501) response code.
- rdp-html5 console type only.
- AUTO or
- MANUAL.
- AUTO or
- MANUAL.
- AUTO or
- MANUAL.
- AUTO or
- MANUAL.
- AUTO or
- MANUAL.
- reserve in
- the request body. To release a fixed IP address, specify
- unreserve in the request body.
- addTenantAccess action and the
- tenant_id in the request body.
- removeTenantAccess action and the
- tenant_id in the request body.
- policy.json file.
- floating_ip_pools object.
- policy.json file.
- pool parameter to specify from which pool to
- allocate the IP address.
- policy.json file.
- 400 response code
- with an informational message.
- policy.json file.
- policy.json file.
- policy.json file.
- all_tenants=1 query parameter to ping
- instances for all tenants. For example:
- include and exclude
- query parameters to filter the results. For example:
- policy.json file.
- all_tenants=1 query parameter
- to ping instances for all tenants.
- include=uuid[,uuid...] to include
- the instances in the results.
- exclude=uuid[,uuid...] to exclude
- the instances from the results.
- policy.json file.
- interfaceAttachment
- action in the request body.
- net_id and port_id
- parameters are mutually exclusive.
- port_id
- parameter, the OpenStack Networking API v2.0
- allocates a port and creates an interface for it
- on the network.
- net_id and port_id
- parameters are mutually exclusive.
- net_id
- parameter, the OpenStack Networking API v2.0 uses
- the network information cache that is associated
- with the instance.
- net_id, the request returns a
- Bad Request (400) response code.
- interfaceAttachment
- action in the response body.
- interfaceAttachment
- action in the response body.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- user_id query parameter.
- user_id query parameter.
- user_id
- query parameter.
- "force": "True"
- attribute in the request body. Default is false.
- The following example request shows the optional
- force attribute.
- user_id
- query parameter.
- user_id
- query parameter.
- from_port) or
- destination port (to_port) value, you must
- specify an IP protocol (ip_protocol) value.
- Otherwise, the operation returns the Bad Request
- (400) response code.
- security_group_rule object.
- security_group_rule object.
- ip_range object.
- group object. Includes the tenant ID and the source
- security group name.
- security_group action in the
- request body.
- network-changed, network-vif-plugged,
- network-vif-unplugged, or
- network-vif-deleted.
- failed, completed, or
- in-progress. Default is
- completed.
- network-changed, network-vif-plugged,
- network-vif-unplugged, or
- network-vif-deleted.
- failed, completed, or
- in-progress. Default is
- completed.
- server_groups object.
- anti-affinity and
- affinity.all_projects
- query parameter to list all server groups for all projects.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- policy.json file.
- OS-EXT-VIF-NET:net_id
- response attribute.
- net_id response attribute.
- ACTIVE, PAUSED,
- SHUTOFF, VERIFY_RESIZE, or
- SOFT_DELETED status.
- available status.
- in-use.
- available
- state, the request failed. Ensure that you meet the
- preconditions and run the request again. If the
- request fails again, investigate the server and the
- volume status.
- /dev/vdb. Omit or set this
- parameter to null for auto-assignment, if supported. If you specify
- this parameter, the device must not exist in the guest operating system.
-
- Note that as of the 12.0.0 Liberty release, the Nova libvirt driver
- no longer honors a user-supplied device name. This is the same
- behavior as if the device name parameter is not supplied on the
- request.
- ACTIVE, PAUSED,
- SHUTOFF, VERIFY_RESIZE, or
- SOFT_DELETED.
- in-use.
- available.
- in-use
- state, the request 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.
- Forbidden (403)
- response code.
- volume object.volume_types object.createBackup action in the request
- body.
- policy.json file.
- injectNetworkInfo action in the
- request body.
- policy.json file.
- host parameter to specify the destination
- host. If you omit this parameter, the scheduler chooses a
- host. If a scheduled host is not suitable, the scheduler tries
- up to migrate_max_retries rescheduling attempts.
- block_migration parameter to
- true. If either host uses shared storage, the
- migration fails if you set this parameter to
- true.
- policy.json file.
- migrate action in the request body.
- policy.json file.
- resetNetwork action in
- the request body.
- policy.json file.
- os-resetState action and the
- state in the request body.
- policy.json file.
- os-getConsoleOutput action in the
- request body.
- -1 indicates unlimited.
- forceDelete action in the request body.
- policy.json file.
- restore action in the request body.
- policy.json file.
- evacuate action in the request body.
- evacuate action in the
- request body.
- addFixedIp action and the network ID
- in the request body.
- policy.json file.
- removeFixedIp action in the request body.
- policy.json file.
- addFixedIp action and the network ID
- in the request body.
- policy.json file.
- removeFixedIp action in the request body.
- policy.json file.
- os-getRDPConsole action in the
- request body.
- os-getSerialConsole action in the request
- body.
- os-getSPICEConsole action in the request
- body.
- os-getVNCConsole action in the request
- body.
- shelve action in the request
- body.
- unshelve action. To remove a shelved instance, use
- the shelveOffload action.
- policy.json file.
- ACTIVE,
- SHUTOFF, PAUSED, or
- SUSPENDED.
- SHELVED and the image status is
- ACTIVE. The server instance data appears on
- the compute node that the Compute service manages.
- shelved_offload_time option to 0, the Compute
- service automatically deletes the instance on compute
- nodes and changes the server status to
- SHELVED_OFFLOADED.
- 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.
- shelveOffload action in the request body.
- policy.json file.
- SHELVED.SHELVED_OFFLOADED.
- The server instance data appears on the compute
- node.SHELVED_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.unshelve action in the request
- body.
- policy.json file.
- SHELVED or SHELVED_OFFLOADED.
- ACTIVE. The server appears on the compute node.
- 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.
- trigger_crash_dump action in the request
- body.
- /var/crash directory.
- policy.json file.
- addFloatingIp action
- in the request body.
- fixed_address
- parameter.
- available.changePassword action in the request
- body.
- policy.json file.
- confirmResize action in the request
- body.
- ACTIVE or SHUTOFF and
- a migration_status of confirmed. You can also
- see the resized server in the compute node that OpenStack
- Compute manages.
- VERIFY_RESIZED, the vm_status is RESIZED,
- and the migration_status is finished or
- confirming.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.
- createImage action in the request body.
- active 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.
- ACTIVE, SHUTOFF,
- PAUSED, or SUSPENDED.lock action in the request body.
- policy.json file.
- PAUSED.
- pause action in the request body.
- policy.json file.
- ACTIVE.
- os-start action in the request body.
- SHUTOFF.
- ACTIVE. The server appears on the compute node that the
- Compute service manages.
- 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.
- SHUTOFF.
- os-stop action in the request body.
- ACTIVE or ERROR.
- SHUTOFF. The server instance data appears
- only on the compute node that Compute service manages.
- reboot action in the request body.
- rebuild action in the request body.
- preserve_ephemeral
- parameter to true.
- removeFloatingIp action in the request
- body.
- RESCUE.
- rescue action in the request body.
- rescue_image_ref extended
- attribute, the image is used to rescue the instance.
- If you omit an image reference, the base image reference is
- used by default.
- GET
- /v2.1/​{tenant_id}​/servers/​{server_id}​
- request, its status changes to RESCUE.resize action in the request body.
- VERIFY_RESIZE status, RESIZED VM
- status, and finished migration status. If you set
- the resize_confirm_window option of the
- Compute service to an integer value, the Compute service
- automatically confirms the resize operation after the set
- interval in seconds.
- ACTIVE or SHUTOFF.
- ACTIVE.
- resume action in the request body.
- policy.json file.
- revertResize action in the request
- body.
- ACTIVE or SHUTOFF
- and a migration_status of reverted. You can
- also see the reverted server in the compute node that
- OpenStack Compute manages.
- VERIFY_RESIZE and the vm_status is RESIZED.
- RESIZED, the request failed. Ensure you meet the
- preconditions and run the request again. If the request fails again,
- investigate the compute back end.SUSPENDED.
- suspend action in the request body.
- policy.json file.
- unlock action in the request body.
- policy.json file.
- ACTIVE.
- unpause action in the request body.
- policy.json file.
- ACTIVE.
- unrescue action in the request body.
- RESCUE.GET
- /v2.1/​{tenant_id}​/servers/​{server_id}​
- request, its status changes to ACTIVE.
- addSecurityGroup action in the request body.
- removeSecurityGroup action in the
- request body.
- "return_reservation_id": "True" in the
- request body to request that a reservation ID be returned
- instead of the newly created instance information. With this
- parameter, the response shows only the reservation ID.
- GET
- /servers/{id} request. This call returns a progress
- attribute, which is a percentage value from 0 to 100.
- Location header returns the full URL to the newly
- created server and is available as a self and
- bookmark link in the server representation.
- block-device-mapping-v2 parameter
- in the create request body to boot a server from a volume.
- key_name parameter in the create request
- body to add a keypair to the server when you create it.
- To create a keypair, make a
- create keypair request.
- ACTIVE through API calls.
- BUILDING or
- shows another error status, the request failed. Ensure
- you meet the preconditions then investigate the
- compute node.
- ACTIVE. The server is active.
- 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.
- MIGRATING. The server is being migrated to a new host.
- 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
- command was passed to the operating system.
- REBUILD. The server is currently being rebuilt from an
- 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.
- 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
- disk images are still available to restore.
- STOPPED. The server is powered off and the disk image
- still persists.
- SUSPENDED. The server is suspended,
- either by request or necessity. This status appears for only
- 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.
- VERIFY_RESIZE. System is awaiting confirmation
- that the server is operational after a move or resize.
- OS-EXT-STS:vm_state, OS-EXT-STS:power_state, and
- OS-EXT-STS:task_state attributes.
- OS-SRV-USG:launched_at and OS-SRV-USG:terminated_at
- attributes.
- addresses information for instances in a
- certain state, set the
- osapi_hide_server_address_states configuration
- option. Set this option to a valid VM state in the
- nova.conf configuration file.
- OS-EXT-STS:vm_state, OS-EXT-STS:power_state, and
- OS-EXT-STS:task_state attributes.
- OS-SRV-USG:launched_at and OS-SRV-USG:terminated_at
- attributes.
- addresses information for instances in a
- certain state, set the
- osapi_hide_server_address_states configuration
- option. Set this option to a valid VM state in the
- nova.conf configuration file.
- accessIPv4, accessIPv6,
- diskConfig and name attributes.
- DELETED through API calls.
- deleting status or
- another error status, the request failed. Ensure that you
- meet the preconditions. Then, investigate the compute back
- end.
- This schema file defines actions that can be performed on a - cloud server. All cloud server actions are derived from the Action type.
-Types related to servers.
-Performs a HARD or SOFT reboot.
-Rebuilds a server.
-Resizes a server.
-Confirms a resize action.
-Reverts a resize action.
-Changes a server's password.
-The action creates a new image for the server.
-This is the base type for all server actions. It is simply - a marker abstract type used to differentiate an Action - element from other elements.
-The type - of reboot to perform.
-A collection of meta data items associated with the - server. If not specified the original server - metadata will be kept.
-A collection of small files - used to personalize a new server instance. Existing - server personality files are deleted by the rebuild - process.
-The name of the server. If not specified the original - server name will be kept.
-The server's administration password.
-A reference to an image to use for the rebuild. A - local image need contain only an Image ID. External - images must contain a link that provides the full path - to the image resource. You must supply an image when - rebuilding.
-The IPv4 primary IP.
-The IPv6 primary IP.
-A reference to the flavor to convert to.
-The server's administration password.
-A collection of meta data items associated with the - image.
-The name of the image to create.
-A HARD reboot is equivalent to power cycling the - server. The operating system is not allowed to - gracefully shutdown.
-With a SOFT reboot, the operating system is signaled to - restart. This allows for a graceful shutdown of all - processes.
-- This is the main index XML Schema document - for Common API Schema Types Version 1.0. -
-- Types related to extensions. -
-- Types related to rate and absolute limits. -
-- Types related to API version details. -
-- This is the main index XML Schema document - for the Open Stack Compute API Version 1.1. -
-- Servers and all internal Entities including Addresses and - Files. -
-- Types related to images. -
-- Types related to flavors. -
-- Defines server actions: reboot, rebuild, resize... -
-- Metadata for Server and Image. -
-- All fault types. -
-- This schema file simple defines an atom link according - to RFC4287 -
-This schema document describes the XML namespace, in a form - suitable for import by other schema documents.
-See - http://www.w3.org/XML/1998/namespace.html and - http://www.w3.org/TR/REC-xml for information about this - namespace.
-Note that local names in this namespace are intended to be - defined only by the World Wide Web Consortium or its subgroups. - The names currently defined in this namespace are listed below. - They should not be used with conflicting semantics by any - Working Group, specification, or document instance.
-See further below in this document for more information about - how to refer to this schema document from your - own XSD schema documents and about the namespace-versioning policy governing this schema - document.
-denotes an attribute whose value is a language code for the - natural language of the content of any element; its value is - inherited. This name is reserved by virtue of its definition in - the XML specification.
-Attempting to install the relevant ISO 2- and 3-letter codes - as the enumerated possible values is probably never going to be - a realistic possibility.
-See BCP 47 at - http://www.rfc-editor.org/rfc/bcp/bcp47.txt and the IANA - language sub tag registry at http://www.iana.org/assignments/language-subtag-registry - for further information.
-The union allows for the 'un-declaration' of xml:lang with the - empty string.
-denotes an attribute whose value is a keyword indicating what - whitespace processing discipline is intended for the content of - the element; its value is inherited. This name is reserved by - virtue of its definition in the XML specification.
-denotes an attribute whose value provides a URI to be used as - the base for interpreting any relative URIs in the scope of the - element on which it appears; its value is inherited. This name - is reserved by virtue of its definition in the XML Base - specification.
-See http://www.w3.org/TR/xmlbase/ for information about this - attribute.
-denotes an attribute whose value should be interpreted as if - declared to be of type ID. This name is reserved by virtue of - its definition in the xml:id specification.
-See http://www.w3.org/TR/xml-id/ for information about this - attribute.
-denotes Jon Bosak, the chair of the original XML Working - Group. This name is reserved by the following decision of the - W3C XML Plenary and XML Coordination groups:
---In appreciation for his vision, leadership and dedication the - W3C XML Plenary on this 10th day of February, 2000, reserves - for Jon Bosak in perpetuity the XML name "xml:Father".
-
This schema defines attributes and an attribute group suitable
- for use by schemas wishing to allow xml:base,
- xml:lang, xml:space or
- xml:id attributes on elements they define.
To enable this, such a schema must import this schema for the - XML namespace, e.g. as follows:
-- <schema . . .> - . . . - <import namespace="http://www.w3.org/XML/1998/namespace" - schemaLocation="http://www.w3.org/2001/xml.xsd"/>-
or
-<import namespace="http://www.w3.org/XML/1998/namespace" - schemaLocation="http://www.w3.org/2009/01/xml.xsd"/>-
Subsequently, qualified reference to any of the attributes or - the group defined below will have the desired effect, e.g.
-<type . . .> - . . . - <attributeGroup ref="xml:specialAttrs"/>-
will define a type which will schema-validate an instance - element with any of those attributes.
-In keeping with the XML Schema WG's standard versioning - policy, this schema document will persist at - http://www.w3.org/2009/01/xml.xsd.
-At the date of issue it can also be found at - http://www.w3.org/2001/xml.xsd.
-The schema document at that URI may however change in the - future, to remain compatible with the latest version of - XML Schema itself, or with the XML namespace itself. In other - words, if the XML Schema or XML namespaces change, the version - of this document at - http://www.w3.org/2001/xml.xsd will change accordingly; - the version at - http://www.w3.org/2009/01/xml.xsd will not change.
-Previous dated (and unchanging) versions of this schema - document are at:
- -- This schema file defines all entities related to Backup Schedules. -
-- This element is used to create periodic daily and weekly - images automatically. -
-- If true, both daily and weekly backup schedules are - disabled. -
-- A WeeklyBackup type that describes the day - of the week in which to perform a weekly backup or - DISABLED if weekly backups are disabled. -
-- A DailyBackup type that describes an hour - range in which to perform a daily backup or DISABLED if - daily backups are disabled. -
-- A target GMT hour range in which to perform a daily backup - or DISABLED if daily backups are disabled. -
-- Daily backups are disabled. -
-- Daily backup target of 00:00–02:00 GMT. -
-- Daily backup target of 02:00–04:00 GMT. -
-- Daily backup target of 04:00–06:00 GMT. -
-- Daily backup target of 06:00–08:00 GMT. -
-- Daily backup target of 08:00–10:00 GMT. -
-- Daily backup target of 10:00–12:00 GMT. -
-- Daily backup target of 12:00–14:00 GMT. -
-- Daily backup target of 14:00–16:00 GMT. -
-- Daily backup target of 16:00–18:00 GMT. -
-- Daily backup target of 18:00–20:00 GMT. -
-- Daily backup target of 20:00–22:00 GMT. -
-- Daily backup target of 22:00–00:00 GMT. -
-- A target day of the week in which to perform a weekly backup - or DISABLED if daily backups are disabled. -
-- Weekly backups are disabled. -
-- A weekly backup target of Sunday. -
-- A weekly backup target of Monday. -
-- A weekly backup target of Tuesday. -
-- A weekly backup target of Wednesday. -
-- A weekly backup target of Thursday. -
-- A weekly backup target of Friday. -
-- A weekly backup target of Saturday. -
-- A weekly backup target of Sunday. -
-This schema file defines common types used by multiple - entities and possibly spanning several types of requests.
-A collection of metadata items. An absolute limit - might impose additional constraints on the number of - metadata items.
-A MetadataItem is simply a name-value pair. The name is - specified in the key attribute and the value is included inline.
-A meta data name-value pair.
-An integer between 0 and 100 that denotes the progress of - an operation.
-A universally unique identifier.
-An extended status must contain a prefix.
-- A flag that identifies whether a disk is auto - managed or manual managed. The attribute can only - be applied to an Image. -
-- This schema file defines types related to API - extensions. -
-- A list of supported extensions. -
-- Detials about a specific extension. -
-- A list of extensions. -
-- Details about a specific extension. -
-- A short description of what the extension - does. -
-- A human readable extension name. -
-- Extension namespace used for XML representations. -
-- A vendor prefix alias used for non-XML - representations. -
-- The time that the extension was added or - modified. -
-- There should be at least one atom link with a - describedby relation. This relation provides - developer info for the extension. -
-
- Vendor aliases are used to differentiate
- extensions in non-XML representations as well as
- in HTTP headers and in the URL path. An alias is
- made of a vendor prefix, followed be a dash (-)
- followed be a short extension ID. For example:
- RAX-PIE.
-
- This schema file defines faults that the OpenStack Compute API can
- raise. These faults are derived from the ComputeAPIFault. Most faults extend this type without adding any
- additional attributes or elements. The only exceptions are the OverLimitAPIFault, which adds a
- retryAt attribute, and the AsyncAPIFault, which adds a created time stamp.
- Because all faults extend a standard base type, you can capture all
- API faults with a single catch statement.
-
- Faults are associated with a default HTTP status code that corresponds - to the particular fault type. For example an <itemNotFound> element is associated with the HTTP 404 - status code. Some elements, such as the <computeFault> element, might be associated - with multiple status codes. It is also possible for multiple fault - elements to be associated with the same default code. The following - examples show the default status codes for each element type. Note - that these default codes are not part of the formal schema. In - practice, however, an element type is likely associated with its - corresponding default status code. -
-A generic Cloud Servers API fault.
-The item or resource could not be found.
-The operation is not allowed because the corresponding - server is in a build state.
-There is not enough capacity to honor the request.
-The operation is not allowed because the corresponding - server is being re-sized or backed up.
-The API service is currently unavailable.
-Insufficient privileges to honor the request, perhaps an - authentication token needs to be obtained or renewed.
-Authentication has been validated, however the operation is - unauthorized.
-The request is malformed.
-The Content Type of the request is not supported.
-The HTTP method (or verb) is not - supported by the corresponding resource.
-The operation is currently not implemented.
-A human readable message that is appropriate for - display to the end user.
-The optional <details> element might contain - useful information for tracking down errors, such as a - stack trace. This information might or might not be - appropriate for display to an end user.
-The HTTP status code associated with the current - fault.
-An optional dateTime denoting when an operation - should be retried.
-An optional dateTime that indicates when the fault - was created.
-This schema file defines all entities related to Flavors.
-Common types used by multiple entities and possibly - spanning several types of requests.
-The element defines an available hardware configuration - for a server.
-A collection of flavors.
-- The ID of the flavor. -
-The name of the flavor.
-The amount of RAM in the flavor in megabytes.
-The amount of disk space in the flavor in gigabytes. -
-The amount of cores allocated.
-The only allowed attributes for this Flavor type is the - name, ID, and links. This type is used for non-detailed list - of flavors.
-- The flavor MUST contain a name, UUID, - bookmark link, and self link. -
-A collection of flavors.
-A collection of flavors with ID, names, and links only. - This type is used for non-detailed list of flavors.
-This schema file defines all entity related to Images.
-Common types used by multiple entities and possibly - spanning several types of requests.
-All fault types.
-The element defines a collection of files used to create or - rebuild a server.
-A collection of images.
-The server associated with the image. This may not - contain full server details but will always contain an - ID, a name, as well as self and bookmark links.
-A collection of meta data items associated with the - image.
-The details of a fault that may have occurred while - creating an image.
-The UUID of the image.
-The name of the image.
-A unique ID that identifies the tenant that contains the - image.
-A unique ID that identifies the user who created the - image.
-- A time stamp when the image was modified. -
-A creation time-stamp for the image.
-The progress of the current image operation.
-The current state (or status) of the image.
-Minimum disk space required for the image in - gigabytes.
-The minimum amount of RAM required for the image in - megabytes.
-The only allowed attribute for this Image type is the name, - ID, and links. This is used for non-detailed list of - images.
-Here the image MUST contain a name, - an ID, a bookmark link, and a self link.
-A collection of images (all details).
-A collection of images with only IDs, names, and links. - This is used for the non-detailed list of images.
-An extensible image status type allows all of the strings - defined in ImageStatus or an alias prefixed status.
-The image is in an unknown state.
-All operations have completed successfully, the image - is available for install.
-The image is being created (or saved).
-The image has been deleted.
-The requested operation has failed.
-- This schema file defines all entities related to Shared IP Groups. -
-- Common types used by multiple entities and possibly spanning - several types of requests. -
-- The element defines a group of servers that can share one or - more public IPs with each other. -
-- A collection of shared IP groups. -
-- An IP group type can take two basic forms. On a request - a single, optional, server ID may be specified… -
-- …on a response a server ID list is always returned. This - server list may be empty… -
-- …note that is a mutually exclusive choice: either - a <server> or <servers> element must be - specified, but not both. -
-- A single, optional, server ID. This form is used when - creating an IP group. -
-- A collection of server IDs. This form is used when - querying an IP group. -
-- The UUID of the shared IP group. Do not specify this attribute - when creating a new shared IP group. -
-- The name of the shared IP group. -
-- A collection of shared IP groups. -
-- A collection of servers within a shared IP group. -
-- The UUID of a server within a shared IP group. -
-This schema file defines types related to - preconfigured limits. Limits are used to manage the - capacity of the API and to prevent abuse. The API - defines two kinds of limits Rate Limits and Absolute Limits. Rate Limits are thresholds - that are reset after a certain amount of time passes. - Absolute limits are fixed.
-The limits element contains information on both - rate and absolute limits.
-- This schema file defines metadata for servers and images. -
-- Common types used by multiple entities and possibly spanning - several types of requests. -
-- The element defines a Metadata. -
-- The element defines a metadata item. -
-This schema file defines a Server and all internal - entities related to servers including Addresses and - Files.
-Common types used by multiple entities and possibly - spanning several types of requests.
-Types related to images.
-Types related to flavors.
-All fault types.
-The element defines a server.
-A collection of servers.
-The element defines list of addresses by network: (public, - private, ...).
-The element defines a list of addresses in a network.
-The element defines an individual IP address.
-A server is a virtual - machine instance in the Cloud Servers system. Note that this - complex type defines all elements and attributes as optional - because a server instance may take many different forms - depending on the operation. When creating a server, for - example, the name, imageRef, and flavorRef attributes are - required. In addition, optional metadata and personality - file elements may be specified:
-The response to such a crate operation will include the - administration password, host ID, and addresses associated - with the server:
-When modifying a server only the name and administration - password should be specified as these are the only - attributes that are modifiable.
-A reference to an image used to create the server. - External images must contain a link that provides the - full path to the image resource.
-The current server flavor. This may not contains all - flavor details but will always contain an ID, a name, as - well as self and bookmark links.
-A collection of meta data items associated with the - server.
-A server's public and private address.
-A collection of small files - used to personalize a new server instance.
-The details of a fault that may have occurred while - creating the server or performing a server action.
-The name of the server.
-A reference to an image. This is used exclusively when - creating a server. Using an image ID here indicates that - the image is locally hosted.
-A reference to a flavor. This is used exclusively when - creating a server. Using a flavorRef here indicates that - the flavor is locally hosted.
-The IPv4 primary IP.
-The IPv6 primary IP.
-The UUID of the server.
-The server's administration password.
-A unique ID that identifies the tenant that contains the - server.
-A unique ID that identifies the user who created the - server.
-A unique ID that identifies the physical host that the VM - is running on. This ID is unique per - account and not globally unique.
-The progress of the current server operation.
-The current state (or status) of the server.
-The time the server was updated.
-The time the server was created.
-The only allowed attribute for this Server type is the - name, ID, and links. This type is used for non-detailed - server lists.
-Here the server MUST contain a name, - an ID, a bookmark link, and a self link.
-The only allowed attribute for this Server type is the ID, - and links. This type is used for holding external references - to servers.
-Here the server MUST contain an ID, - a bookmark link, and a self link.
-When creating a server the server must contain a name and a - reference to an image and flavor.
-A collection of meta data items associated with the - server.
-A collection of small files used to personalize a new server - instance.
-When updating a server. The server - MUST contain either a name or - metadata or access address. The other fields are not - editable on a server update.
-A collection of servers.
-A collection of servers with only IDs, names, and links. A - collection of this type is returned in non-detailed server - list.
-A collection of files.
-A file is simply a full path along with base64 file - content. The name of the file is specified in the path - attribute and the file - content is included inline.
-Full file path.
-A collection of addresses.
-A id of an address list. This is typically a name used to - identify a network.
-An IP address.
-The IP Address version can be 4 or 6. The version - attribute is optional if it is left off, the type of - address will be determined by from its address format. If - it is specified it should match the - address format.
-The OpenStack compute API will always fill in the version - number as a convenience to the client.
-An extensible server status type allows all of the strings - defined in ServerStatus or an alias prefixed status.
-The server is ready to use.
-The server is in an inactive (suspended) state.
-The server has been deleted.
-The server is being resized.
-The server is waiting for the resize operation to be - confirmed so that the original server may be - removed.
-A resized server is being reverted to its previous - size.
-The requested operation failed, the server is in an - error state.
-The server is being built.
-The server password is being changed.
-The server is being rebuilt.
-The server is going through a SOFT reboot.
-The server is going through a HARD reboot.
-The server is in an unknown state.
-Denotes IPv4.
-Denotes IPv6.
-- The element defines request to share a public IP address. -
-- This type is used to represent a request to share an IP - address. -
-- The - shared IP group - - use to - share the address. -
-- If true, the server is configured with the new address - though the address may not be enabled. -
-This schema file defines all types related to - versioning.
-This element is returned when the version of the - resource cannot be determined. The element - provides a list of choices for the resource.
-Provides a list of supported versions.
-This element provides detailed meta information - regarding the status of the current API version. - This is the XSD 1.0 compatible element - definition.
-This element provides detailed meta information - regarding the status of the current API version. - The description should include a pointer to both a - human readable and a machine processable - description of the API service.
-Loading...-
|
- |
-
- |
-
Your browser does not seem to have support for - namespace nodes in XPath. If you're a Firefox - user, please consider voting to get this issue - resolved: - https://bugzilla.mozilla.org/show_bug.cgi?id=94270 - -
-|
- |
-
- |
-
|
- |
-
-
-
-
-
-
-
- |
-
|
-
-
-
-
-
-
- |
-
|
- |
-
- |
-
|
- |
-
- |
-
|
- |
- |
| enum values | -|
| - |