OpenStack APIs2010-2013OpenStack API ReferenceUse the OpenStack APIs in your OpenStack cloud: Identity
service, Compute and Compute extensions, Image service, Volumes,
and Object Storage. You must install the packages for each API
separately. After you authenticate through the Identity service
API, you can use the other APIs and extensions to launch server
instances, create images, assign metadata to instances and
images, create containers and objects, and complete other
actions in your OpenStack cloud. To get started with the APIs, see the API Quick Start Guide. For detailed information, read
descriptions or specifications for each API. IdentityGets an authentication token that permits access to the
Compute API for 24 hours. The version of the Identity API is
2.0.ComputeLaunches virtual machines based on the images uploaded to
the system. Also, connects to a server instance securely through
SSH once it starts and reboots or resizes server instances as
needed. API v1.1 is identical to API v2.Compute ExtensionsAdds capabilities to the Compute API beyond those defined in
the core API. Use extensions to add features, MIME types,
actions, states, headers, parameters, and resources to the core
API. Query the Compute API to list available extensions with a
GET request to v2/extensions.Server - Extended CreateShows extra information when you create a server.Servers - Multiple CreateCreates multiple servers with an optional reservation
ID.Server Console OutputGets the output from the console log for a server.Server DiagnosticsGets the usage data for a server.Server VNC ConsoleAccesses a VNC console for a specified server.Server PasswordThis extension retrieves and resets the encrypted admin
password set through metadata service.Server Start/StopStarts and stops a server.Server RescueRescues or unrescues a server.Admin ActionsPermits administrators to perform actions on a
server.Disk ConfigExtends servers and images with a diskConfig
attribute.Server Force Delete/RestoreRestores or force-deletes a server when you deploy nova
with deferred delete on.Extended Instance StatusAdds vm_state, task_state, and power_state to detailed
server responses.Extended Server AttributesAdds metadata to and shows additional metadata for
servers.Fixed IPsShows data for a specified fixed IP, such as host name,
CIDR, and address. Also, reserves or frees a fixed IP.Floating IPsAssigns and allocates floating IP addresses to instances
that run in an OpenStack cloud. Floating IPs BulkBulk creates, deletes, and lists floating IPs. By default,
the pool is named nova. Use the
os-floating-ip-pools extension to view
available pools.Floating IP DNSManages DNS records associated with IP addresses allocated
by the Floating IPs extension. Requests are dispatched to a
DNS driver selected at startup. Floating IP PoolsManages groups of floating IPs.Server IP TypeThis extension shows the type of the IPs assigned to an
instance, either fixed or floating.Host AggregatesCreates and manages host aggregates. An aggregate assigns
metadata to groups of compute nodes. Aggregates are only
visible to the cloud provider. AgentsCreates, updates, and deletes guest agents. Use guest
agents to access files on the disk, configure networking, or
run other applications or scripts in the guest while it runs.
This hypervisor-specific extension is not currently enabled
for KVM. Use of guest agents is possible only if the
underlying service provider uses the Xen driver.CloudpipeManages virtual vpns for projects.Flavors Create and DeleteCreates and deletes flavors.Flavors with the rxtx_factor Extended AttributeCreates a flavor, gets details for a specified flavor, and
lists details for available flavors. Includes the
rxtx_factor extended attribute, related
to configured bandwidth cap values. Flavors with Extended AttributesCreates a flavor, gets details for a flavor, and
lists details for available flavors. Includes the
rxtx_factor,
OS-FLV-EXT-DATA:ephermeral, and
swap extended attributes.KeypairsGenerates, imports, and deletes SSH keys.HostsManages physical hosts.HypervisorsDisplays extra statistical information from the machine
that hosts the hypervisor through the API for the hypervisor
(XenAPI or KVM/libvirt). NetworksShows network information and deletes networks. Also,
disassociates a network from a project if you use vlan mode. Quota SetsPermits administrators, depending on policy settings, to
view quotas for a tenant and view and update default
quotas.Scheduler HintsProvides information directly to the scheduler when you
create a server. Security GroupsCreates, modifies, and deletes security groups and
rules.Simple UsageReports statistics on compute and storage
resources.Virtual InterfacesLists the virtual interfaces for a specified server
instance.Used LimitsExtends limits to show the usage of per project limits.
Shows information such as RAM or instance quotas usage.ImageLoads images for use at launch time by the Compute API. Some
cloud implementations do not expose this API and offer
pre-tested images only. Also, assigns metadata to images. VolumesVolumeManages volumes and snapshots for use with the Volume API
(nova-volume or cinder services).Volume Extension to ComputeManages volumes and snapshots for use with the Compute
API.Volume AttachmentsAttaches volumes created through the volume API to server
instances. Also, lists volume attachments for a server
instance, gets volume details for a volume attachment, and
deletes a volume attachment.Object StorageManages the accounts, containers and objects in the object
storage system.