Remove unnecessary word, "specified," throughout
Change-Id: Ia3f476a7799c32041bd0301743e07d3633f9cb3e Closes-Bug: #1514130
This commit is contained in:
parent
eeb5f44fb8
commit
2f3f09b5fc
api-quick-start/source
api-ref/src
docbkx
ch_blockstorage-api-v2.xmlch_compute-v2.1.xmlch_data-processing-v1.1.xmlch_identity-v3-ext.xmlch_images-v2.xmlch_netconn-v2-ext.xmlch_objectstorage-v1.xmlch_share-v2-experimental.xmlch_share-v2.xmlch_telemetry-v2.xml
wadls
common_project.ent
compute-api/src/v2.1
common.ent
wadl
diagnostics-v2.1.wadlimages-v2.1.wadlkeypairs-v2.1.wadlos-admin-actions-v2.1.wadlos-aggregates-v2.1.wadlos-attach-interfaces-v2.1.wadlos-baremetal-nodes-v2.1.wadlos-cells-v2.1.wadlos-certificates-v2.1.wadlos-cloudpipe-v2.1.wadlos-compute-2.1.wadlos-console-output-v2.1.wadlos-consoles-v2.1.wadlos-deferred-delete-v2.1.wadlos-disk-config-v2.1.wadlos-evacuate-v2.1.wadlos-extensions-v2.1.wadlos-fixed-ips-v2.1.wadlos-flavor-access-v2.1.wadlos-flavor-extra-specs-v2.1.wadlos-flavors-v2.1.wadlos-floating-ip-dns-v2.1.wadlos-floating-ips-bulk-v2.1.wadlos-floating-ips-v2.1.wadlos-fping-v2.1.wadlos-hosts-v2.1.wadlos-hypervisors-v2.1.wadlos-instance-usage-audit-log-v2.1.wadlos-multinic-v2.1.wadlos-networks-v2.1.wadlos-pci-v2.1.wadlos-quota-class-sets-v2.1.wadlos-quota-sets-v2.1.wadlos-remote-consoles-v2.1.wadlos-security-group-default-rules-v2.1.wadlos-security-group-rules-v2.1.wadlos-security-groups-v2.1.wadlos-server-actions-add-v2.1.wadlos-server-actions-v2.1.wadlos-server-groups-v2.1.wadlos-server-password-v2.1.wadlos-services-v2.1.wadlos-shelve-v2.1.wadlos-simple-tenant-usage-v2.1.wadlos-tenant-networks-v2.1.wadlos-virtual-interfaces-v2.1.wadlos-volumes-v2.1.wadlserver-ips-v2.1.wadlserver-metadata-v2.1.wadl
databases-api/xsd
dataprocessing-api/src/v1.1/wadl
clusters.wadldata-sources.wadlimage-registry.wadljob-binaries.wadljob-binary-internals.wadljob-executions.wadljob-types.wadljobs.wadlnode-group-template.wadlplugins.wadl
identity-api/src
v2.0/wadl
OS-KSADM-admin.wadlOS-KSEC2-admin.wadlOS-KSS3-admin.wadlOS-KSVALIDATE-admin.wadlcommon.entidentity-admin.wadlidentity.wadl
v3/wadl
image-api/src
v1
v2
netconn-api/src
@ -60,21 +60,20 @@ The payload of credentials to authenticate contains these parameters:
|
||||
+-----------------------+----------------+--------------------------------------+
|
||||
| *tenantName* | xsd:string | The tenant name. Both the |
|
||||
| (Optional) | | *tenantId* and *tenantName* |
|
||||
| | | are optional, but should not be |
|
||||
| | | specified together. If both |
|
||||
| | | attributes are specified, the server |
|
||||
| | | responds with a 400 Bad Request. |
|
||||
| | | are optional and mutually exclusive. |
|
||||
| | | If you specify both attributes, the |
|
||||
| | | server returns the Bad Request (400) |
|
||||
| | | response code. |
|
||||
+-----------------------+----------------+--------------------------------------+
|
||||
| *tenantId* | xsd:string | The tenant ID. Both the |
|
||||
| (Optional) | | *tenantId* and *tenantName* |
|
||||
| | | are optional, but should not be |
|
||||
| | | specified together. If both |
|
||||
| | | attributes are specified, the server |
|
||||
| | | responds with a 400 Bad Request. If |
|
||||
| | | you do not know the tenantId, you |
|
||||
| | | can send a request with "" for the |
|
||||
| | | tenantId and get the ID returned to |
|
||||
| | | you in the response. |
|
||||
| (Optional) | | *tenantId* and *tenantName* |
|
||||
| | | are optional and mutually exclusive. |
|
||||
| | | If you specify both attributes, the |
|
||||
| | | server returns the Bad Request (400) |
|
||||
| | | response code. If you do not know |
|
||||
| | | the tenant ID, send a request with |
|
||||
| | | "" for the tenant ID. The response |
|
||||
| | | returns the tenant ID. |
|
||||
+-----------------------+----------------+--------------------------------------+
|
||||
| token (Optional) | xsd:string | A token. If you do not provide a |
|
||||
| | | token, you must provide a user name |
|
||||
@ -93,7 +92,7 @@ command to request a token with your tenantName and ID:
|
||||
{"username": "'"$OS_USERNAME"'", "password": "'"$OS_PASSWORD"'"}}}' \
|
||||
| python -m json.tool
|
||||
|
||||
If the request succeeds, you receive a 200 OK response followed by a
|
||||
If the request succeeds, it returns the OK (200) response code followed by a
|
||||
response body that contains a token in the form ``"id":"token"`` and an
|
||||
expiration date and time in the form ``"expires":"datetime"``.
|
||||
|
||||
@ -685,8 +684,7 @@ create`` command with the image and flavor IDs and the server name, as follows:
|
||||
+--------------------------------------+---------------------------------------------------------+
|
||||
|
||||
.. note::
|
||||
For information about the default ports that the OpenStack components
|
||||
use, see `Firewalls and default ports`_ in the *OpenStack Configuration
|
||||
Reference*.
|
||||
For information about the default ports that the OpenStack components use,
|
||||
see `Firewalls and default ports`_ in the *OpenStack Configuration Reference*.
|
||||
|
||||
.. _Firewalls and default ports: http://docs.openstack.org/liberty/config-reference/content/firewalls-default-ports.html
|
||||
|
@ -515,7 +515,7 @@
|
||||
<section xml:id="os-vol-image-meta-v2">
|
||||
<title>Volume image metadata extension (os-vol-image-meta)</title>
|
||||
<para>
|
||||
Shows image metadata that is associated with a specified volume.
|
||||
Shows image metadata that is associated with a volume.
|
||||
</para>
|
||||
<wadl:resources href="../wadls/volume-api/src/v2/os-vol-image-meta-v2.wadl"/>
|
||||
</section>
|
||||
|
@ -89,11 +89,11 @@
|
||||
<para><emphasis role="bold">Passwords</emphasis></para>
|
||||
<para>
|
||||
When you create a server, you can specify a password through the
|
||||
optional <property>adminPass</property> attribute. The specified
|
||||
password must meet the complexity requirements set by your OpenStack
|
||||
Compute provider. The server might enter an <code>ERROR</code> state
|
||||
if the complexity requirements are not met. In this case, a client
|
||||
might issue a change password action to reset the server password.
|
||||
optional <property>adminPass</property> attribute. The password must
|
||||
meet the complexity requirements set by your OpenStack Compute
|
||||
provider. The server might enter an <code>ERROR</code> state if the
|
||||
complexity requirements are not met. In this case, a client might
|
||||
issue a change password action to reset the server password.
|
||||
</para>
|
||||
<para>
|
||||
If you do not specify a password, the API generates and assigns a
|
||||
@ -185,9 +185,9 @@
|
||||
is built and booted.
|
||||
</para>
|
||||
<para>
|
||||
During file injection, any existing files that match specified files
|
||||
are renamed to include the BAK extension appended with a time stamp.
|
||||
For example, if the <code>/etc/passwd</code> file exists, it is
|
||||
During file injection, any existing files that match files in the
|
||||
request are renamed to include the BAK extension appended with a time
|
||||
stamp. For example, if the <code>/etc/passwd</code> file exists, it is
|
||||
backed up as <code>/etc/passwd.bak.1246036261.5785</code>.
|
||||
</para>
|
||||
<para>
|
||||
@ -314,7 +314,7 @@
|
||||
<title>Servers IPs (servers, ips)</title>
|
||||
<para>
|
||||
Lists the IP addresses assigned to an instance or shows details for
|
||||
a specified IP address.
|
||||
a IP address.
|
||||
</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v2.1/wadl/server-ips-v2.1.wadl"
|
||||
@ -327,8 +327,8 @@
|
||||
items, and updates one or more metadata items for a server.
|
||||
</para>
|
||||
<para>
|
||||
Shows details for, creates or replaces, and updates a specified
|
||||
metadata item, by key, for a server.
|
||||
Shows details for, creates or replaces, and updates a metadata item,
|
||||
by key, for a server.
|
||||
</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v2.1/wadl/server-metadata-v2.1.wadl"
|
||||
@ -337,9 +337,8 @@
|
||||
<section xml:id="os-server-actions-add-v2.1">
|
||||
<title>Servers action (servers, os-server-actions)</title>
|
||||
<para>
|
||||
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.
|
||||
Permits all users to list available server actions for a server. Permits
|
||||
administrators to get details for a server action for a server.
|
||||
</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v2.1/wadl/os-server-actions-add-v2.1.wadl"
|
||||
@ -358,7 +357,7 @@
|
||||
<section xml:id="os-virtual-interfaces-v2.1">
|
||||
<title>Servers virtual interfaces (servers, os-virtual-interfaces)</title>
|
||||
<para>
|
||||
Lists virtual interfaces for a specified server instance.
|
||||
Lists virtual interfaces for a server instance.
|
||||
</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v2.1/wadl/os-virtual-interfaces-v2.1.wadl"
|
||||
@ -592,7 +591,7 @@
|
||||
<section xml:id="os-fixed-ips-v2.1">
|
||||
<title>Fixed IPs (os-fixed-ips)</title>
|
||||
<para>
|
||||
Shows data for a specified fixed IP, such as host name, CIDR, and
|
||||
Shows data for a fixed IP, such as host name, CIDR, and
|
||||
address. Also, reserves and frees a fixed IP address.
|
||||
</para>
|
||||
<wadl:resources
|
||||
@ -642,7 +641,7 @@
|
||||
<section xml:id="v2.1os-fping">
|
||||
<title>Ping instances (os-fping)</title>
|
||||
<para>
|
||||
Pings all or specified instances and reports which ones are alive.
|
||||
Pings instances and reports which ones are alive.
|
||||
</para>
|
||||
<wadl:resources
|
||||
href="../wadls/compute-api/src/v2.1/wadl/os-fping-v2.1.wadl"
|
||||
@ -792,9 +791,9 @@
|
||||
<title>Manage services (os-services)</title>
|
||||
<para>
|
||||
Lists all or only disabled Compute services for all hosts in a
|
||||
specified tenant. Logs information for disabled services. Enables
|
||||
or disables scheduling for, forces down, unsets the forced-down
|
||||
state of, or deletes a specified service.
|
||||
tenant. Logs information for disabled services. Enables or
|
||||
disables scheduling for, forces down, unsets the forced-down state
|
||||
of, or deletes a service.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/compute-api/src/v2.1/wadl/os-services-v2.1.wadl#os-services">
|
||||
|
@ -228,8 +228,8 @@
|
||||
<title>Job executions</title>
|
||||
<para>
|
||||
A job execution object represents a Hadoop job that runs on a
|
||||
specified cluster. A job execution polls the status of a running
|
||||
job and reports it to the user. Also a user can cancel a running job.
|
||||
cluster. A job execution polls the status of a running job and
|
||||
reports it to the user. Also a user can cancel a running job.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job-executions">
|
||||
|
@ -300,8 +300,8 @@ Trust extension (OS-TRUST)
|
||||
<para>
|
||||
Request and access tokens use token keys to identify themselves.
|
||||
For OpenStack purposes, the token key is the token ID. The
|
||||
consumer uses a token secret to establish ownership of a specified
|
||||
token. Both request and access tokens have token secrets.
|
||||
consumer uses a token secret to establish ownership of a token.
|
||||
Both request and access tokens have token secrets.
|
||||
</para>
|
||||
<para>
|
||||
Delegated authentication through OAuth occurs as follows:
|
||||
|
@ -190,10 +190,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-resourcetype-v2">
|
||||
<title>Metadata definition resource types</title>
|
||||
<title>Metadata definition resource types (since API v2.0)</title>
|
||||
<para>
|
||||
Lists resource types. Also, creates, lists, and removes resource
|
||||
type associations in a specified namespace. (Since API v2.0.)
|
||||
Lists resource types. Also, creates, lists, and
|
||||
removes resource type associations in a namespace.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
@ -212,12 +212,11 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-namespace-v2">
|
||||
<title>Metadata definition namespaces</title>
|
||||
<title>Metadata definition namespaces (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and deletes metadata
|
||||
definition namespaces. Defines namespaces that can contain
|
||||
property definitions, object definitions, and resource type
|
||||
associations. (Since API v2.0.)
|
||||
Creates, lists, gets details for, updates, and
|
||||
deletes metadata definition namespaces. Defines namespaces that can contain
|
||||
property definitions, object definitions, and resource type associations.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
@ -234,10 +233,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-property-v2.wadl">
|
||||
<title>Metadata definition properties</title>
|
||||
<title>Metadata definition properties (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and deletes metadata
|
||||
definition properties. (Since API v2.0.)
|
||||
Creates, lists, gets details for, updates, and
|
||||
deletes metadata definition properties.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
@ -253,10 +252,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-object-v2">
|
||||
<title>Metadata definition objects</title>
|
||||
<title>Metadata definition objects (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and deletes metadata
|
||||
definition objects. (Since API v2.0.)
|
||||
definition objects.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-object-v2.wadl#objects">
|
||||
@ -271,10 +270,10 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-metadef-tag-v2">
|
||||
<title>Metadata definition tags</title>
|
||||
<title>Metadata definition tags (since API v2.0)</title>
|
||||
<para>
|
||||
Creates, lists, gets details for, updates, and deletes metadata
|
||||
definition tags. (Since API v2.0.)
|
||||
definition tags.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/image-api/src/v2/os-metadef-tag-v2.wadl#tags">
|
||||
@ -340,9 +339,9 @@
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="os-tasks-v2">
|
||||
<title>Tasks</title>
|
||||
<title>Tasks (since API v2.2)</title>
|
||||
<para>
|
||||
Creates, lists, and gets details for tasks. (Since API v2.2.)
|
||||
Creates, lists, and gets details for tasks.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
|
@ -14,7 +14,7 @@
|
||||
<title>Networking API v2.0 extensions (CURRENT)</title>
|
||||
<section xml:id="neutron_extensions">
|
||||
<title>Extensions</title>
|
||||
<para>Lists available Networking API v2.0 extensions and shows details for a specified
|
||||
<para>Lists available Networking API v2.0 extensions and shows details for an
|
||||
extension.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/netconn-api/src/os-networks.wadl#extensions">
|
||||
@ -63,19 +63,25 @@
|
||||
error occurs.</para>
|
||||
<para>To delete a network with multiple physical bindings, issue a normal delete network
|
||||
request.</para>
|
||||
<para>To define multiple physical bindings for a network, include a
|
||||
<code>segments</code> list in the request body of a <code>POST
|
||||
/v2.0/networks</code> request. Each element in the <code>segments</code> list
|
||||
has the same structure as the provider network attributes. These attributes are
|
||||
<code>provider:network_type</code>,
|
||||
<code>provider:physical_network</code>, and
|
||||
<code>provider:segmentation_id</code>. The validation rules for these
|
||||
attributes are the same as for the <link
|
||||
xlink:href="http://developer.openstack.org/api-ref-networking-v2.html#network_provider-ext"
|
||||
>Networks provider extended attributes</link>. You cannot use both extensions at the
|
||||
same time.</para>
|
||||
<para>The NSX and ML2 plug-ins support this extension. With the ML2 plug-in, you can specify
|
||||
multiple VLANs for a specified network, a VXLAN tunnel ID, and a VLAN.</para>
|
||||
<para>
|
||||
To define multiple physical bindings for a network, include a
|
||||
<code>segments</code> list in the request body of a <code>POST
|
||||
/v2.0/networks</code> request. Each element in the
|
||||
<code>segments</code> list has the same structure as the provider
|
||||
network attributes. These attributes are
|
||||
<code>provider:network_type</code>,
|
||||
<code>provider:physical_network</code>, and
|
||||
<code>provider:segmentation_id</code>. The validation rules for
|
||||
these attributes are the same as for the <link
|
||||
xlink:href="http://developer.openstack.org/api-ref-networking-v2.html#network_provider-ext">Networks
|
||||
provider extended attributes</link>. You cannot use both extensions at the
|
||||
same time.
|
||||
</para>
|
||||
<para>
|
||||
The NSX and ML2 plug-ins support this extension. With the ML2
|
||||
plug-in, you can specify multiple VLANs for a network, a VXLAN
|
||||
tunnel ID, and a VLAN.
|
||||
</para>
|
||||
<wadl:resources href="../wadls/netconn-api/src/os-networks-multi-provider-ext.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
|
@ -72,7 +72,7 @@ Accept-Ranges: bytes</programlisting>
|
||||
<section xml:id="storage_endpoints">
|
||||
<title>Endpoints</title>
|
||||
<para>
|
||||
If configured, lists endpoints for a specified account.
|
||||
If configured, lists endpoints for an account.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
@ -84,7 +84,7 @@ Accept-Ranges: bytes</programlisting>
|
||||
<section xml:id="storage_account_services">
|
||||
<title>Accounts</title>
|
||||
<para>
|
||||
Lists containers for a specified account. Creates, updates, shows,
|
||||
Lists containers for an account. Creates, updates, shows,
|
||||
and deletes account metadata.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
@ -99,7 +99,7 @@ Accept-Ranges: bytes</programlisting>
|
||||
<section xml:id="storage_container_services">
|
||||
<title>Containers</title>
|
||||
<para>
|
||||
Lists objects in a specified container. Creates, shows details
|
||||
Lists objects in a container. Creates, shows details
|
||||
for, and deletes containers. Creates, updates, shows, and deletes
|
||||
container metadata.
|
||||
</para>
|
||||
|
@ -37,7 +37,7 @@
|
||||
</para>
|
||||
<para>
|
||||
As an administrator, you can also reset the state of a consistency
|
||||
group and force-delete a specified consistency group in any state.
|
||||
group and force-delete a consistency group in any state.
|
||||
Use the <code>policy.json</code> file to grant permissions for
|
||||
these actions to other roles.
|
||||
</para>
|
||||
@ -75,11 +75,11 @@
|
||||
of the consistency group from which the consistency group snapshot
|
||||
was created. Then, when you use consistency group snapshots to
|
||||
restore data, you can easily determine which shares belong to a
|
||||
specified consistency group.
|
||||
consistency group.
|
||||
</para>
|
||||
<para>
|
||||
As an administrator, you can also reset the state of a consistency
|
||||
group snapshot and force-delete a specified consistency group
|
||||
group snapshot and force-delete a consistency group
|
||||
snapshot in any state. Use the <code>policy.json</code> file to
|
||||
grant permissions for these actions to other roles.
|
||||
</para>
|
||||
|
@ -108,7 +108,7 @@
|
||||
</para>
|
||||
<para>
|
||||
You can create a share and associate it with a network, list shares,
|
||||
and show information for, update, and delete a specified share.
|
||||
and show information for, update, and delete a share.
|
||||
</para>
|
||||
<para>
|
||||
To create a share, specify one of these supported protocols:
|
||||
@ -318,7 +318,7 @@
|
||||
<title>Share actions</title>
|
||||
<para>
|
||||
Grants or revokes share access, lists the permissions for a
|
||||
specified share, and explicitly updates the state of a share.
|
||||
share, and explicitly updates the state of a share.
|
||||
</para>
|
||||
<para>
|
||||
To grant or revoke share access, specify one of these supported
|
||||
@ -359,10 +359,9 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>user</code>. Authenticates by a specified user or
|
||||
group name. A valid value is an alphanumeric string that
|
||||
can contain some special characters and is from 4 to 32
|
||||
characters long.
|
||||
<code>user</code>. Authenticates by a user or group name.
|
||||
A valid value is an alphanumeric string that can contain some special
|
||||
characters and is from 4 to 32 characters long.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -372,7 +371,7 @@
|
||||
</para>
|
||||
<para>
|
||||
As administrator, you can reset the state of a share and
|
||||
force-delete a specified share in any state. Use the
|
||||
force-delete a share in any state. Use the
|
||||
<code>policy.json</code> file to grant permissions for this
|
||||
action to other roles.
|
||||
</para>
|
||||
@ -440,7 +439,7 @@
|
||||
</itemizedlist>
|
||||
<para>
|
||||
As administrator, you can also reset the state of a snapshot and
|
||||
force-delete a specified share snapshot in any state.
|
||||
force-delete a share snapshot in any state.
|
||||
Use the <code>policy.json</code> file to grant permissions for
|
||||
these actions to other roles.
|
||||
</para>
|
||||
@ -755,7 +754,7 @@
|
||||
<para>
|
||||
You can manage the access to the private share types for the
|
||||
different projects. You can add access, remove access, and get
|
||||
information about access for a specified private share type.
|
||||
information about access for a private share type.
|
||||
</para>
|
||||
<para>
|
||||
Administrators can create share types with these extra
|
||||
@ -881,7 +880,7 @@
|
||||
<code>down</code>).
|
||||
</para>
|
||||
<para>
|
||||
Administrators can also enable or disable a specified service.
|
||||
Administrators can also enable or disable a service.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-services">
|
||||
@ -909,7 +908,7 @@
|
||||
<section xml:id="share-os-share-manage" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Manage share</title>
|
||||
<para>
|
||||
Configures Shared File Systems to manage a specified share.
|
||||
Configures Shared File Systems to manage a share.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-share-manage">
|
||||
@ -920,7 +919,7 @@
|
||||
<section xml:id="share-os-share-unmanage" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Unmanage share</title>
|
||||
<para>
|
||||
Configures Shared File Systems to unmanage a specified share.
|
||||
Configures Shared File Systems to unmanage a share.
|
||||
</para>
|
||||
<para>
|
||||
The share unmanage operation is not supported for shares that are
|
||||
|
@ -46,7 +46,7 @@
|
||||
configuration option value.
|
||||
</para>
|
||||
<para>
|
||||
Also, computes and lists statistics for samples in a specified
|
||||
Also, computes and lists statistics for samples in a
|
||||
time range. You can use the <code>aggregate</code> query parameter
|
||||
in the <code>statistics</code> URI to explicitly select the
|
||||
<code>stddev</code>, <code>cardinality</code>, or any other
|
||||
@ -110,7 +110,7 @@
|
||||
<listitem>
|
||||
<para>
|
||||
The total number of instance samples (<code>count</code>)
|
||||
for a specified tenant in 15-minute intervals (<code>period</code> and
|
||||
for a tenant in 15-minute intervals (<code>period</code> and
|
||||
<code>groupby</code> options)
|
||||
</para>
|
||||
</listitem>
|
||||
@ -192,7 +192,7 @@
|
||||
<section xml:id="samples">
|
||||
<title>Samples</title>
|
||||
<para>
|
||||
Lists all samples and gets information for a specified sample.
|
||||
Lists all samples and gets information for a sample.
|
||||
</para>
|
||||
<para>
|
||||
For list operations, if you do not explicitly set the
|
||||
|
@ -6,11 +6,12 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Requests a specified page size of returned items from the query.
|
||||
Returns a number of items up to the specified limit value. Use the
|
||||
Requests a page size of returned items from the query.
|
||||
Returns a number of items up to a limit value. Use the
|
||||
<code>limit</code> parameter to make an initial limited request
|
||||
and use the ID of the last-seen item from the response as the
|
||||
<code>marker</code> parameter value in a subsequent limited request.
|
||||
<code>marker</code> parameter value in a subsequent limited
|
||||
request.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -73,9 +74,9 @@
|
||||
Use this query parameter to check for changes since a previous request
|
||||
rather than re-downloading and re-parsing the full status at each
|
||||
polling interval. If data has changed, only the items changed since
|
||||
the specified time are returned in the response. If data has not
|
||||
changed since the <code>changes-since</code> time, an empty list is
|
||||
returned.
|
||||
the <code>changes-since</code> time are returned in the response. If
|
||||
data has not changed since the <code>changes-since</code> time, an
|
||||
empty list is returned.
|
||||
</para>
|
||||
<para>
|
||||
For example, issue a &GET; request against the following endpoint to
|
||||
@ -128,7 +129,8 @@
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the <code>created_at</code> date and time stamp, its value is <code>null</code>.
|
||||
If you omit the <code>created_at</code> date and time stamp, its value
|
||||
is <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -154,7 +156,8 @@
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the <code>deleted_at</code> date and time stamp, its value is <code>null</code>.
|
||||
If you omit the <code>deleted_at</code> date and time stamp, its value
|
||||
is <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -201,31 +204,32 @@
|
||||
<!ENTITY updated_at-RequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at" style="plain"
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server or image was updated.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the time zone, the UTC time zone is assumed.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the <code>updated_at</code> date and time stamp, its value is <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server or image was updated.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the time zone, the UTC time zone is assumed.
|
||||
</para>
|
||||
<para>
|
||||
If you omit the <code>updated_at</code> date and time stamp, its value
|
||||
is <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY updatedResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated" style="plain"
|
||||
@ -257,47 +261,49 @@
|
||||
<!ENTITY created_at-ResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="created_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server, image, or backup was created.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an offset from UTC.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server, image, or backup was created.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY createdResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="created" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server, image, or backup was created.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an offset from UTC.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
name="created" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server, image, or backup was created.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY Date-ResponseHeader '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -313,71 +319,68 @@
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
A <code>null</code> value indicates that the token never expires.
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
A <code>null</code> value indicates that the token never expires.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY deleted_at-ResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="deleted_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server or image was deleted.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
If the <code>deleted_at</code> date and time stamp is not set, its value is
|
||||
<code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the server or image was deleted.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY expires-ResponseParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="expires" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the token expires.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
A <code>null</code> value indicates that the token never expires.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
name="expires" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time when the token expires.
|
||||
</para>
|
||||
<para>
|
||||
The date and time stamp format is <link
|
||||
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
|
||||
</para>
|
||||
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
|
||||
<para>
|
||||
The <code>±hh:mm</code> value, if included, is the time zone as an
|
||||
offset from UTC.
|
||||
</para>
|
||||
<para>
|
||||
For example, <code>2015-08-27T09:49:58-05:00</code>.
|
||||
</para>
|
||||
<para>
|
||||
A <code>null</code> value indicates that the token never expires.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY expires_at-ResponseParameter '
|
||||
<param name="expires_at"
|
||||
@ -653,6 +656,8 @@ type="xsd:dateTime" xmlns="http://wadl.dev.java.net/2009/02">
|
||||
</param>'>
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY COPY '<command xmlns="http://docbook.org/ns/docbook">COPY</command>'>
|
||||
<!ENTITY HEAD '<command xmlns="http://docbook.org/ns/docbook">HEAD</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
|
@ -91,7 +91,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified server name in URL format.</para>
|
||||
<para>Filters the results by a server name in URL format.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -99,7 +99,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified server name in string format.</para>
|
||||
<para>Filters the results by a server name in string format.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -108,7 +108,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the results by a specified image status. For example,
|
||||
Filters the results by a image status. For example,
|
||||
<code>ACTIVE</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -120,7 +120,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the results by a specified image type. For example,
|
||||
Filters the results by a image type. For example,
|
||||
<code>BASE</code>, <code>SERVER</code>, or <code>ALL</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -310,10 +310,10 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Enables booting the server from a volume when additional parameters are
|
||||
given. If specified, the volume status must be <code>available</code>,
|
||||
and the volume <code>attach_status</code> in the OpenStack Block Storage
|
||||
database must be <code>detached</code>.
|
||||
Enables you to boot a server from a volume when you specify additional
|
||||
parameters. If you specify the volume status, you must set it to
|
||||
<code>available</code>. In the OpenStack Block Storage database, the
|
||||
volume <code>attach_status</code> must be <code>detached</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -1487,7 +1487,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<para>Filters the results by a specified server status. For example,
|
||||
<para>Filters the results by a server status. For example,
|
||||
<code>ACTIVE</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -1700,7 +1700,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified image name in URL format.</para>
|
||||
<para>Filters the results by a image name in URL format.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -1708,7 +1708,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified flavor name in URL format.</para>
|
||||
<para>Filters the results by a flavor name in URL format.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -1716,7 +1716,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified server name in string format.</para>
|
||||
<para>Filters the results by a server name in string format.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&limitMarkerReqParameter;
|
||||
@ -1726,7 +1726,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the results by a specified server status. For example,
|
||||
Filters the results by a server status. For example,
|
||||
<code>ACTIVE</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1736,7 +1736,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified host name in string format.</para>
|
||||
<para>Filters the results by a host name in string format.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
|
||||
@ -1815,9 +1815,11 @@
|
||||
The addresses for the server.
|
||||
</para>
|
||||
<para>
|
||||
If <code>osapi_hide_server_address_states</code> is set, addresses
|
||||
information is hidden for any server in the specified state. By default,
|
||||
servers in <code>BUILDING</code> state hide their addresses information.
|
||||
Addresses information is hidden for any server in a state set in the
|
||||
<code>osapi_hide_server_address_states</code> configuration option. By
|
||||
default, servers in <code>building</code> state hide their addresses
|
||||
information. See <link
|
||||
xlink:href="http://docs.openstack.org/liberty/config-reference/content/list-of-compute-config-options.html">nova.conf - configuration options</link>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -1945,7 +1947,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified minimum disk space in GB.</para>
|
||||
<para>Filters the results by a minimum disk space in GB.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -1953,7 +1955,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Filters the results by a specified minimum RAM in MB.</para>
|
||||
<para>Filters the results by a minimum RAM in MB.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&limitMarkerReqParameter;'>
|
||||
@ -2677,7 +2679,7 @@
|
||||
Use this query parameter to check for changes since a previous request
|
||||
rather than re-downloading and re-parsing the full status at each polling
|
||||
interval. If data has changed, the call returns only the items changed
|
||||
since the specified time. If data has not changed since the
|
||||
since the <code>changes-since</code> time. If data has not changed since the
|
||||
<code>changes-since</code> time, the call returns an empty list.
|
||||
</para>
|
||||
<para>
|
||||
|
@ -31,12 +31,13 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get server diagnostics">
|
||||
<para role="shortdesc">
|
||||
Gets basic usage data for a specified server.
|
||||
Gets basic usage data for a server.
|
||||
</para>
|
||||
<para>
|
||||
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 <code>policy.json</code> file.
|
||||
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
|
||||
<code>policy.json</code> file.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
@ -34,7 +34,9 @@
|
||||
<resource id="image_id" path="{image_id}">
|
||||
<param name="image_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="image_id">
|
||||
<para>The UUID for the image.</para>
|
||||
<para>
|
||||
The UUID for the image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getImage" />
|
||||
@ -43,7 +45,10 @@
|
||||
<resource id="imageMetadataKey" path="{key}">
|
||||
<param name="key" style="template" type="csapi:imageMetadataKey">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Metadata item key">
|
||||
<para>A string. Maximum length is 255 characters.</para>
|
||||
<para>
|
||||
The metadata item key, as a string.
|
||||
Maximum length is 255 characters.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getImageMetadataItem" />
|
||||
@ -61,7 +66,9 @@
|
||||
<!--*******************************************************-->
|
||||
<resource_type id="DetailImageList">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detail image list">
|
||||
<para>A detailed image list.</para>
|
||||
<para>
|
||||
A detailed image list.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<method href="#listDetailImages"/>
|
||||
</resource_type>
|
||||
@ -76,7 +83,9 @@
|
||||
</resource_type>
|
||||
<resource_type id="ImageMetadataDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Image metadata list">
|
||||
<para>Metadata details for an image.</para>
|
||||
<para>
|
||||
Metadata details for an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<method href="#showImageMetadata"/>
|
||||
<method href="#createImageMetadata"/>
|
||||
@ -88,7 +97,9 @@
|
||||
<!-- Images -->
|
||||
<method name="GET" id="listDetailImages">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="List images details">
|
||||
<para role="shortdesc">Lists all details for available images.</para>
|
||||
<para role="shortdesc">
|
||||
Lists all details for available images.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -152,7 +163,9 @@
|
||||
</method>
|
||||
<method name="GET" id="listImages">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List images">
|
||||
<para role="shortdesc">Lists IDs, names, and links for available images.</para>
|
||||
<para role="shortdesc">
|
||||
Lists IDs, names, and links for available images.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/xml">
|
||||
@ -226,11 +239,13 @@
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults --> &commonFaults;
|
||||
&commonFaults;
|
||||
</method>
|
||||
<method name="GET" id="getImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get image details">
|
||||
<para role="shortdesc">Gets details for a specified image.</para>
|
||||
<para role="shortdesc">
|
||||
Gets details for an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -248,19 +263,23 @@
|
||||
&x-compute-request-idHeader;
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common and GET Faults--> &commonFaults; &getFaults;
|
||||
&commonFaults; &getFaults;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete image">
|
||||
<para role="shortdesc">Deletes a specified image.</para>
|
||||
<para role="shortdesc">
|
||||
Deletes an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
<!-- Common and GET Faults --> &commonFaults; &getFaults;
|
||||
&commonFaults; &getFaults;
|
||||
</method>
|
||||
<!-- Metadata -->
|
||||
<method name="GET" id="showImageMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Show image metadata">
|
||||
<para role="shortdesc">Shows metadata for a specified image.</para>
|
||||
<para role="shortdesc">
|
||||
Shows metadata for an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -273,7 +292,8 @@
|
||||
<param name="next" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='next']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the next metadata item.
|
||||
<para>
|
||||
Moves to the next metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ServerMetadataDetails" rel="next"/>
|
||||
@ -281,7 +301,8 @@
|
||||
<param name="previous" style="plain" type="xsd:anyURI"
|
||||
path="/csapi:metadata/atom:link[@rel='previous']/@href">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Moves to the previous metadata item.
|
||||
<para>
|
||||
Moves to the previous metadata item.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<link resource_type="#ServerMetadataDetails" rel="previous"/>
|
||||
@ -314,14 +335,17 @@
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
||||
&commonFaults; &getFaults;
|
||||
</method>
|
||||
<method name="POST" id="updateImageMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update image metadata items">
|
||||
<para role="shortdesc">Updates metadata items by key for a specified image.</para>
|
||||
<para>Replaces items that match the specified keys and does not modify items not
|
||||
specified in the request.
|
||||
<para role="shortdesc">
|
||||
Updates metadata items, by key, for an image.
|
||||
</para>
|
||||
<para>
|
||||
Replaces items that match the a keys and does not modify items not
|
||||
a in the request.
|
||||
</para>
|
||||
<para>
|
||||
If this operation exceeds the metadata items quota, the API throws
|
||||
@ -360,15 +384,18 @@
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
||||
&commonFaults; &getFaults; &postPutFaults;
|
||||
&inProgressFault;
|
||||
</method>
|
||||
<method name="PUT" id="createImageMetadata">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or replace image metadata">
|
||||
<para role="shortdesc">Creates or replaces metadata for a specified image.</para>
|
||||
<para>Replaces items that match the specified keys. If you omit a key that already
|
||||
exists, this key retains its value.
|
||||
<para role="shortdesc">
|
||||
Creates or replaces metadata for an image.
|
||||
</para>
|
||||
<para>
|
||||
Replaces items that match specified keys. If you omit a key that
|
||||
already exists, this key retains its value.
|
||||
</para>
|
||||
<para>
|
||||
If this operation exceeds the metadata items quota, the API throws
|
||||
@ -407,14 +434,14 @@
|
||||
</param>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
||||
&commonFaults; &getFaults; &postPutFaults;
|
||||
&inProgressFault;
|
||||
</method>
|
||||
<method name="GET" id="getImageMetadataItem">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show image metadata item details">
|
||||
<para role="shortdesc">Shows details for a metadata item by key for a specified
|
||||
image.
|
||||
<para role="shortdesc">
|
||||
Shows details for a metadata item, by key, for an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -433,17 +460,17 @@
|
||||
&x-compute-request-idHeader;
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common Faults and GET Faults--> &commonFaults; &getFaults;
|
||||
&commonFaults; &getFaults;
|
||||
</method>
|
||||
<method name="PUT" id="setImageMetadataItem">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or update image metadata item">
|
||||
<para role="shortdesc">Creates or updates a metadata item by key for a specified
|
||||
image.
|
||||
<para role="shortdesc">
|
||||
Creates or updates a metadata item, by key, for an image.
|
||||
</para>
|
||||
<para>
|
||||
If this operation exceeds the metadata items quota,
|
||||
the API throws an <code>overLimit (413)</code> fault.
|
||||
If this operation exceeds the metadata items quota, the API throws
|
||||
an <code>overLimit (413)</code> fault.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -460,23 +487,27 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<!-- Common, GET, POST/PUT, inProgress Faults--> &commonFaults; &getFaults; &postPutFaults;
|
||||
&commonFaults; &getFaults; &postPutFaults;
|
||||
&inProgressFault;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteServerMetadataItem">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete server metadata item">
|
||||
<para role="shortdesc">Deletes a metadata item by key for a specified server.</para>
|
||||
<para role="shortdesc">
|
||||
Deletes a metadata item, by key, for a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
||||
&commonFaults; &getFaults; &inProgressFault;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteImageMetadataItem">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete image metadata item">
|
||||
<para role="shortdesc">Deletes a metadata item by key for a specified image.</para>
|
||||
<para role="shortdesc">
|
||||
Deletes a metadata item, by key, for an image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
<!-- Common, GET, inProgress Faults--> &commonFaults; &getFaults; &inProgressFault;
|
||||
&commonFaults; &getFaults; &inProgressFault;
|
||||
</method>
|
||||
</application>
|
||||
|
@ -74,7 +74,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete keypair">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified keypair.
|
||||
Deletes a keypair.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
|
@ -46,7 +46,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Change administrative password (changePassword action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Changes the administrative password for a specified server.
|
||||
Changes the administrative password for a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>changePassword</code> action in the request
|
||||
@ -75,7 +75,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Create server back up (createBackup action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Creates a back up of a specified server.
|
||||
Creates a back up of a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>createBackup</code> action in the request
|
||||
@ -104,7 +104,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Inject network information (injectNetworkInfo action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Injects network information into a specified server.
|
||||
Injects network information into a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>injectNetworkInfo</code> action in the
|
||||
@ -133,7 +133,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Live-migrate server (os-migrateLive action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Live-migrates a specified server to a new host without
|
||||
Live-migrates a server to a new host without
|
||||
rebooting.
|
||||
</para>
|
||||
<para>
|
||||
@ -163,7 +163,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Lock server (lock action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Locks a specified server.
|
||||
Locks a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>lock</code> action in the request body.
|
||||
@ -191,7 +191,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Migrate server (migrate action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Migrates a specified server to a host. The scheduler chooses
|
||||
Migrates a server to a host. The scheduler chooses
|
||||
the host.
|
||||
</para>
|
||||
<para>
|
||||
@ -219,7 +219,7 @@
|
||||
<method name="POST" id="pause">
|
||||
<wadl:doc xml:lang="EN" title="Pause server (pause action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Pauses a specified server. Changes its status
|
||||
<para role="shortdesc">Pauses a server. Changes its status
|
||||
to <code>PAUSED</code>.</para>
|
||||
<para>
|
||||
Specify the <code>pause</code> action in the request body.
|
||||
@ -247,7 +247,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Reset networking on a server (resetNetwork action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Resets networking on a specified server.
|
||||
Resets networking on a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>resetNetwork</code> action in
|
||||
@ -275,8 +275,7 @@
|
||||
<method name="POST" id="resetState">
|
||||
<wadl:doc xml:lang="EN" title="Reset server state (os-resetState action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Resets the state of a specified server to a
|
||||
specified state.</para>
|
||||
<para role="shortdesc">Resets the state of a server.</para>
|
||||
<para>
|
||||
Specify the <code>os-resetState</code> action and the
|
||||
<code>state</code> in the request body.
|
||||
@ -335,7 +334,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Suspend server (suspend action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Suspends a specified server and changes its status to
|
||||
Suspends a server and changes its status to
|
||||
<code>SUSPENDED</code>.
|
||||
</para>
|
||||
<para>
|
||||
@ -364,7 +363,7 @@
|
||||
<method name="POST" id="unlock">
|
||||
<wadl:doc xml:lang="EN" title="Unlock server (unlock action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Unlocks a specified server.</para>
|
||||
<para role="shortdesc">Unlocks a server.</para>
|
||||
<para>
|
||||
Specify the <code>unlock</code> action in the request body.
|
||||
</para>
|
||||
|
@ -39,7 +39,7 @@
|
||||
<method name="POST" id="createaggregate">
|
||||
<wadl:doc xml:lang="EN" title="Create aggregate"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Creates a specified aggregate in a specified availability zone.</para>
|
||||
<para role="shortdesc">Creates a aggregate in a availability zone.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -65,7 +65,7 @@
|
||||
<method name="POST" id="addhost">
|
||||
<wadl:doc xml:lang="EN" title="Add host"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Adds a host to the specified
|
||||
<para role="shortdesc">Adds a host to an
|
||||
aggregate.</para>
|
||||
<para>Specify the <code>add_host</code> action in the request body.</para>
|
||||
</wadl:doc>
|
||||
@ -177,7 +177,7 @@
|
||||
<method name="POST" id="removeaggregate">
|
||||
<wadl:doc xml:lang="EN" title="Remove host"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Removes a host from a specified
|
||||
<para role="shortdesc">Removes a host from an
|
||||
aggregate.</para>
|
||||
<para>Specify the <code>remove_host</code> action in the request body.</para>
|
||||
</wadl:doc>
|
||||
@ -206,7 +206,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Update aggregate"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Updates either or both the name and
|
||||
availability zone for a specified aggregate.</para>
|
||||
availability zone for a aggregate.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -53,8 +53,8 @@
|
||||
<method name="POST" id="createAttachInterface">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create interface">
|
||||
<para role="shortdesc">
|
||||
Creates a port interface and
|
||||
uses it to attach a port to a server instance.
|
||||
Creates a port interface and uses it to attach a port to a
|
||||
server instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -85,9 +85,8 @@
|
||||
<para>
|
||||
If you do not specify the <code>port_id</code>
|
||||
parameter, the OpenStack Networking API v2.0
|
||||
allocates a port and
|
||||
creates an interface for it
|
||||
on the specified network.
|
||||
allocates a port and creates an interface for it
|
||||
on the network.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -115,7 +114,7 @@
|
||||
<para>
|
||||
If you request a specific fixed IP address without
|
||||
a <code>net_id</code>, the request returns a
|
||||
<code>400 BadRequest</code> error code.
|
||||
<code>Bad Request (400)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -160,7 +159,7 @@
|
||||
<method name="GET" id="listAttachedInterfaces">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List interfaces">
|
||||
<para role="shortdesc">Lists port interfaces
|
||||
that are attached to a specified server.
|
||||
that are attached to a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -201,10 +200,10 @@
|
||||
</method>
|
||||
<method name="GET" id="showAttachedInterface">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show port interface information">
|
||||
<para role="shortdesc">Shows information about
|
||||
a specified port interface
|
||||
that is attached to a specified server.
|
||||
title="Show port interface details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a a port interface that is attached to a
|
||||
server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -220,7 +219,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="deleteAttachedInterface">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Detach interface">
|
||||
<para role="shortdesc">Detaches a specified port interface.</para>
|
||||
<para role="shortdesc">Detaches a port interface.</para>
|
||||
</wadl:doc>
|
||||
<response status="202"/> &commonFaults; &postPutFaults;
|
||||
</method>
|
||||
|
@ -78,7 +78,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add bare metal node">
|
||||
<para role="shortdesc">
|
||||
Adds a bare metal node to a specified server.
|
||||
Adds a bare metal node to a server.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
@ -133,15 +133,13 @@
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault;
|
||||
</response> &commonFaults; &getFaults; &postPutFaults; &inProgressFault;
|
||||
</method>
|
||||
<method name="DELETE" id="deleteBaremetalNode">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete bare metal node">
|
||||
<para role="shortdesc">
|
||||
Deletes a bare metal node from a specified server.
|
||||
Deletes a bare metal node from a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</method>
|
||||
@ -150,7 +148,7 @@
|
||||
title="Add interface to bare metal node">
|
||||
<para role="shortdesc">
|
||||
Adds an interface to a bare metal node that is associated with
|
||||
a specified server.
|
||||
a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -172,16 +170,14 @@
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault;
|
||||
</response> &commonFaults; &getFaults; &postPutFaults; &inProgressFault;
|
||||
</method>
|
||||
<method name="POST" id="deleteInterfaceFromBaremetalNode">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete interface from bare metal node">
|
||||
<para role="shortdesc">
|
||||
Deletes an interface from a bare metal node that is associated
|
||||
with a specified server.
|
||||
with a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -194,15 +190,14 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault;
|
||||
&commonFaults; &getFaults; &postPutFaults; &inProgressFault;
|
||||
</method>
|
||||
<method name="GET" id="listBaremetalNodes">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List bare metal nodes">
|
||||
<para role="shortdesc">
|
||||
Lists the bare metal nodes that are associated with a
|
||||
specified server.
|
||||
server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
@ -214,21 +209,19 @@
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
<!-- Common, GET, postput, inProgress Faults--> &commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault;
|
||||
</response> &commonFaults; &getFaults; &postPutFaults; &inProgressFault;
|
||||
</method>
|
||||
<method name="GET" id="showBaremetalNodeDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show bare metal node details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified bare metal node.
|
||||
Shows details for a bare metal node.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The specified bare metal node must be associated with
|
||||
The bare metal node must be associated with
|
||||
the server.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -243,8 +236,6 @@
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response> &commonFaults; &getFaults;
|
||||
&commonFaults;
|
||||
&getFaults; &postPutFaults; &inProgressFault;
|
||||
</response> &commonFaults; &getFaults; &postPutFaults; &inProgressFault;
|
||||
</method>
|
||||
</application>
|
||||
|
@ -36,10 +36,13 @@
|
||||
<method name="GET" id="cellcapacity">
|
||||
<wadl:doc xml:lang="EN" title="Show cell capacities"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows capacities for a specified
|
||||
cell.</para>
|
||||
<para>When cells are not enabled, the cells API calls
|
||||
return a <code>501 NotImplemented</code> error.</para>
|
||||
<para role="shortdesc">
|
||||
Shows capacities for a cell.
|
||||
</para>
|
||||
<para>
|
||||
When cells are not enabled, the call returns the <code>Not
|
||||
Implemented (501)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -54,10 +57,13 @@
|
||||
<method name="GET" id="datacell">
|
||||
<wadl:doc xml:lang="EN" title="Show cell data"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows data for a specified
|
||||
cell.</para>
|
||||
<para>When cells are not enabled, the cells API calls
|
||||
return a <code>501 NotImplemented</code> error.</para>
|
||||
<para role="shortdesc">
|
||||
Shows data for a cell.
|
||||
</para>
|
||||
<para>
|
||||
When cells are not enabled, the call returns the <code>Not
|
||||
Implemented (501)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -73,8 +79,10 @@
|
||||
<wadl:doc xml:lang="EN" title="List cells with details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists cells with details.</para>
|
||||
<para>When cells are not enabled, the cells API calls
|
||||
return a <code>501 NotImplemented</code> error.</para>
|
||||
<para>
|
||||
When cells are not enabled, the call returns the <code>Not
|
||||
Implemented (501)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -90,8 +98,10 @@
|
||||
<wadl:doc xml:lang="EN" title="List cells"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists cells.</para>
|
||||
<para>When cells are not enabled, the cells API calls
|
||||
return a <code>501 NotImplemented</code> error.</para>
|
||||
<para>
|
||||
When cells are not enabled, the call returns the <code>Not
|
||||
Implemented (501)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
@ -46,7 +46,7 @@
|
||||
<method name="GET" id="returncertificate">
|
||||
<wadl:doc xml:lang="EN" title="Show certificate details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified certificate.</para>
|
||||
<para role="shortdesc">Shows details for a certificate.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
@ -71,7 +71,7 @@
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Creates the cloudpipe for
|
||||
the specified project ID. If omitted, the
|
||||
a project. If omitted, the
|
||||
project ID defaults to the calling
|
||||
tenant.</para></wadl:doc>
|
||||
</param>
|
||||
@ -92,7 +92,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update cloudpipe">
|
||||
<para role="shortdesc">Updates the virtual private network
|
||||
(VPN) IP address and port for a specified cloudpipe
|
||||
(VPN) IP address and port for a cloudpipe
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -138,7 +138,7 @@
|
||||
<listitem>
|
||||
<para>
|
||||
The compute node needs enough free resource to match
|
||||
the specified resource of the server creation request.
|
||||
the resource of the server creation request.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -373,7 +373,7 @@
|
||||
<method name="GET" id="getServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get server details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified server.
|
||||
Shows details for a server.
|
||||
</para>
|
||||
<para>
|
||||
Includes server details including configuration
|
||||
@ -405,7 +405,7 @@
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified server must exist.</para>
|
||||
<para>The server must exist.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -423,11 +423,11 @@
|
||||
</method>
|
||||
<method name="PUT" id="updateServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update server">
|
||||
<para role="shortdesc">Updates the editable attributes of the specified server.</para>
|
||||
<para role="shortdesc">Updates the editable attributes of a server.</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified server must exist.</para>
|
||||
<para>The server must exist.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -465,12 +465,12 @@
|
||||
</method>
|
||||
<method name="DELETE" id="deleteServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete server">
|
||||
<para role="shortdesc">Deletes a specified server.</para>
|
||||
<para role="shortdesc">Deletes a server.</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The specified server must exist.</para>
|
||||
The server must exist.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
@ -486,7 +486,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If the specified server is locked, you need to
|
||||
If the server is locked, you need to
|
||||
have administrator privileges to delete the server.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -496,13 +496,13 @@
|
||||
<listitem>
|
||||
<para>
|
||||
With correct permissions, you can see the
|
||||
specified server status as <code>DELETED</code> through API
|
||||
server status as <code>DELETED</code> through API
|
||||
calls.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The port attached to the specified server
|
||||
The port attached to the server
|
||||
is deleted.
|
||||
</para>
|
||||
</listitem>
|
||||
|
@ -31,7 +31,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get console output for a server (os-getConsoleOutput action)">
|
||||
<para role="shortdesc">
|
||||
Gets console output for a specified server instance.
|
||||
Gets console output for a server instance.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>os-getConsoleOutput</code> action in the
|
||||
|
@ -41,7 +41,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create console for server">
|
||||
<para role="shortdesc">
|
||||
Creates a console for a specified server instance.
|
||||
Creates a console for a server instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -54,7 +54,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Lists consoles for server">
|
||||
<para role="shortdesc">
|
||||
Lists all consoles for a specified server instance.
|
||||
Lists all consoles for a server instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -73,7 +73,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show console details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified console for a specified server instance.
|
||||
Shows details for a console for a server instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -92,7 +92,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete console">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified console for a specified server instance.
|
||||
Deletes a console for a server instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
@ -102,7 +102,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show console authentication token">
|
||||
<para role="shortdesc">
|
||||
Shows the authentication token for a specified console for a specified server instance.
|
||||
Shows the authentication token for a console for a server instance.
|
||||
</para>
|
||||
<para>
|
||||
This feature is available for <code>rdp-html5</code> console type only.
|
||||
|
@ -35,7 +35,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Force-delete server (forceDelete action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Force-deletes a specified server before deferred cleanup.
|
||||
Force-deletes a server before deferred cleanup.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>forceDelete</code> action in the request body.
|
||||
|
@ -96,7 +96,7 @@
|
||||
<method name="PUT" id="updateServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update server">
|
||||
<para role="shortdesc">Updates a specified server.</para>
|
||||
<para role="shortdesc">Updates a server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -139,7 +139,7 @@
|
||||
<method name="POST" id="rebuild">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Rebuild server">
|
||||
<para role="shortdesc">Rebuilds a specified server.</para>
|
||||
<para role="shortdesc">Rebuilds a server.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -187,8 +187,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show server information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show server details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
server.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -211,8 +211,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getImage">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get image information">
|
||||
<para role="shortdesc">Gets information for a specified
|
||||
title="Show image details">
|
||||
<para role="shortdesc">Shows details for an
|
||||
image.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
@ -33,7 +33,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Evacuate server (evacuate action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Evacuates a specified server from a failed host to a new one.
|
||||
Evacuates a server from a failed host to a new one.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>evacuate</code> action in the request body.
|
||||
|
@ -121,7 +121,7 @@
|
||||
<method name="GET" id="getExtension">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get extension">
|
||||
<para role="shortdesc">Shows details about a specified
|
||||
<para role="shortdesc">Shows details for an
|
||||
extension.</para>
|
||||
<para>Extensions introduce features and vendor-specific
|
||||
functionality to the API without requiring a version
|
||||
|
@ -42,8 +42,8 @@
|
||||
</resources>
|
||||
<method name="GET" id="showIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show fixed IP information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show fixed IP details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
fixed IP address.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
@ -42,7 +42,7 @@
|
||||
<method name="POST" id="add-flavoraccess-to-tenant">
|
||||
<wadl:doc xml:lang="EN" title="Add flavor access to tenant"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Adds flavor access to a specified
|
||||
<para role="shortdesc">Adds flavor access to a
|
||||
tenant and flavor.</para>
|
||||
<para>
|
||||
Specify the <code>add_tenant_access</code> action and the <code>tenant_id</code> in the request body.
|
||||
@ -128,7 +128,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Remove flavor access from tenant"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Removes the specified flavor access from a specified tenant and
|
||||
Removes flavor access from a tenant and
|
||||
flavor.
|
||||
</para>
|
||||
<para>
|
||||
@ -159,7 +159,7 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
title="Show flavor details with access list"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified flavor. Includes access list information.</para>
|
||||
<para role="shortdesc">Shows details for a flavor. Includes access list information.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
@ -66,7 +66,7 @@
|
||||
<method name="GET" id="showflavor">
|
||||
<wadl:doc xml:lang="EN" title="Show flavor extra specs"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows an extra spec for specified
|
||||
<para role="shortdesc">Shows an extra spec for a
|
||||
flavor, by key.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -91,7 +91,7 @@
|
||||
<method name="GET" id="listflavor">
|
||||
<wadl:doc xml:lang="EN" title="Show flavor extra specs"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists extra specs for a specified
|
||||
<para role="shortdesc">Lists extra specs for a
|
||||
flavor.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -116,8 +116,8 @@
|
||||
<method name="PUT" id="updateflavorspec">
|
||||
<wadl:doc xml:lang="EN" title="Update flavor extra spec"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Updates a specified extra spec value,
|
||||
by key, for a specified flavor.</para>
|
||||
<para role="shortdesc">Updates a extra spec value,
|
||||
by key, for a flavor.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -35,7 +35,7 @@
|
||||
<method name="GET" id="getflavorid">
|
||||
<wadl:doc xml:lang="EN" title="Show flavor details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
flavor.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
|
@ -133,7 +133,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Find unique DNS entry">
|
||||
<para role="shortdesc">Finds a unique DNS entry for a
|
||||
specified domain and name.</para>
|
||||
domain and name.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -149,7 +149,7 @@
|
||||
<method name="GET" id="FindEntriesbyIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List DNS entries">
|
||||
<para role="shortdesc">Lists DNS entries for a specified
|
||||
<para role="shortdesc">Lists DNS entries for a
|
||||
domain and IP.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -166,7 +166,7 @@
|
||||
<method name="DELETE" id="DeleteEntry">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete DNS entry">
|
||||
<para role="shortdesc">Deletes a specified DNS
|
||||
<para role="shortdesc">Deletes a DNS
|
||||
entry.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
|
@ -57,8 +57,7 @@
|
||||
<method name="GET" id="ListFloatingIPsBulkbyHost">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List floating IPs by host">
|
||||
<para role="shortdesc">Lists all floating IPs for a
|
||||
specified host.</para>
|
||||
<para role="shortdesc">Lists all floating IPs for a host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
@ -73,7 +73,10 @@
|
||||
<param name="pool" style="plain">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>Pool to allocate IP address from. Default pool is used, if not specified.</para>
|
||||
<para>
|
||||
Pool from which to allocate IP address. If you
|
||||
omit this parameter, default pool is used.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
or the owner of the server to perform this operation. Cloud providers can change
|
||||
@ -105,7 +108,7 @@
|
||||
<method name="DELETE" id="DeallocateFloatingIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Deallocate floating IP">
|
||||
<para role="shortdesc">Deallocates a specified floating IP address.
|
||||
<para role="shortdesc">Deallocates a floating IP address.
|
||||
</para>
|
||||
<para>
|
||||
You can use this call to deallocate and delete only manually-allocated
|
||||
|
@ -30,7 +30,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Ping instances">
|
||||
<para role="shortdesc">
|
||||
Run the fping utility to ping all or specified instances and
|
||||
Run the fping utility to ping instances and
|
||||
report which ones are alive.
|
||||
</para>
|
||||
<para>
|
||||
@ -42,7 +42,7 @@
|
||||
Specify the <code>include</code> and <code>exclude</code>
|
||||
query parameters to filter the results. For example:
|
||||
</para>
|
||||
<programlisting language="json">GET /os-fping?all_tenants=1&include=uuid1,uuid2&exclude=uuid3,uuid4</programlisting>
|
||||
<programlisting language="json">GET /os-fping?all_tenants=1&include=uuid1,uuid2&exclude=uuid3,uuid4</programlisting>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
or the owner of the server to perform this operation. Cloud
|
||||
@ -70,7 +70,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Specify <code>include=uuid[,uuid...]</code> to include
|
||||
the specified instances in the results.
|
||||
the instances in the results.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -81,7 +81,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Specify <code>exclude=uuid[,uuid...]</code> to exclude
|
||||
the specified instances from the results.
|
||||
the instances from the results.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -102,7 +102,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Ping an instance">
|
||||
<para role="shortdesc">
|
||||
Run the fping utility to ping a specified instance and report
|
||||
Run the fping utility to ping a instance and report
|
||||
whether it is alive.
|
||||
</para>
|
||||
<para>
|
||||
|
@ -57,7 +57,7 @@
|
||||
<method name="GET" id="showinfo">
|
||||
<wadl:doc xml:lang="EN" title="Show host details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -73,7 +73,7 @@
|
||||
<method name="GET" id="shutdownhost">
|
||||
<wadl:doc xml:lang="EN" title="Shut down host"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shuts down a specified host.</para>
|
||||
<para role="shortdesc">Shuts down a host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -88,7 +88,7 @@
|
||||
<method name="GET" id="startshost">
|
||||
<wadl:doc xml:lang="EN" title="Start host"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Starts a specified host.</para>
|
||||
<para role="shortdesc">Starts a host.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -104,7 +104,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Enable host"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Enables or puts a specified host in maintenance mode.
|
||||
Enables or puts a host in maintenance mode.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -31,7 +31,7 @@
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the search results by the specified
|
||||
Filters the search results by the
|
||||
<code>?query={filter}</code> query parameter.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -56,7 +56,7 @@
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>Filters the search
|
||||
results by the specified
|
||||
results by the
|
||||
<code>?query={filter}</code> query
|
||||
parameter.</para>
|
||||
</wadl:doc>
|
||||
@ -104,7 +104,7 @@
|
||||
<method name="GET" id="showhypervisordetails">
|
||||
<wadl:doc xml:lang="EN" title="Show hypervisor details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
hypervisor.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -138,7 +138,7 @@
|
||||
<method name="GET" id="showhypervisoruptime">
|
||||
<wadl:doc xml:lang="EN" title="Show hypervisor uptime"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows the uptime for a specified
|
||||
<para role="shortdesc">Shows the uptime for a
|
||||
hypervisor.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -175,7 +175,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Show hypervisor with PCI statistics"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Shows information for a specified hypervisor. Includes PCI
|
||||
Shows information for a hypervisor. Includes PCI
|
||||
device statistics.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
|
@ -33,7 +33,7 @@
|
||||
<method name="GET" id="listusageaudits">
|
||||
<wadl:doc xml:lang="EN" title="List usage audits for an instance"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists usage audits for a specified
|
||||
<para role="shortdesc">Lists usage audits for an
|
||||
instance.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
@ -35,7 +35,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Add fixed IP to server (addFixedIp action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Adds a fixed IP address to a specified network on a specified server instance.
|
||||
Adds a fixed IP address to a network on a server instance.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>addFixedIp</code> action and the network ID
|
||||
@ -63,7 +63,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Remove fixed IP from server (removeFixedIp action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Removes a fixed IP address from a specified server.
|
||||
Removes a fixed IP address from a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>removeFixedIp</code> action in the request body.
|
||||
|
@ -64,8 +64,8 @@
|
||||
</method>
|
||||
<method name="GET" id="GetNetwork">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show network information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show network details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
network.
|
||||
</para>
|
||||
<para>
|
||||
@ -91,7 +91,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete network">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified network.
|
||||
Deletes a network.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
@ -106,7 +106,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate network">
|
||||
<para role="shortdesc">
|
||||
Disassociates a specified network
|
||||
Disassociates a network
|
||||
from a project so that the network can be
|
||||
reused.
|
||||
</para>
|
||||
@ -133,8 +133,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate project">
|
||||
<para role="shortdesc">
|
||||
Disassociates the project from a
|
||||
specified network.
|
||||
Disassociates the project from a network.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
@ -159,7 +158,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate host">
|
||||
<para role="shortdesc">
|
||||
Disassociates the host from a specified network.
|
||||
Disassociates the host from a network.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
@ -184,7 +183,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Associate host">
|
||||
<para role="shortdesc">
|
||||
Associates a specified network with a host.
|
||||
Associates a network with a host.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
@ -209,7 +208,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Add network">
|
||||
<para role="shortdesc">
|
||||
Adds a specified network to a project.
|
||||
Adds a network to a project.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
|
@ -82,7 +82,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Show PCI device with extra information"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Shows information for a specified PCI device. Includes extra
|
||||
Shows information for a PCI device. Includes extra
|
||||
information.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
|
@ -33,7 +33,7 @@
|
||||
<method name="GET" id="showquota">
|
||||
<wadl:doc xml:lang="EN" title="Show quota"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows the quota for a specified
|
||||
<para role="shortdesc">Shows the quota for a
|
||||
class.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -49,7 +49,7 @@
|
||||
<method name="PUT" id="updatequota">
|
||||
<wadl:doc xml:lang="EN" title="Update quota"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Updates quota for a specified
|
||||
<para role="shortdesc">Updates quota for a
|
||||
class.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -150,7 +150,7 @@
|
||||
<method name="DELETE" id="deletequotauser">
|
||||
<wadl:doc xml:lang="EN" title="Delete quota for user"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Deletes quota for a specified
|
||||
<para role="shortdesc">Deletes quota for a
|
||||
user.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
|
@ -100,7 +100,7 @@
|
||||
title="Get SPICE console for a server (os-getSPICEConsole action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Gets a SPICE console for a specified server.
|
||||
Gets a SPICE console for a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>os-getSPICEConsole</code> action in the request
|
||||
@ -130,7 +130,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Get VNC console for a server (os-getVNCConsole action)"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Gets a VNC console for a specified server.
|
||||
Gets a VNC console for a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>os-getVNCConsole</code> action in the request
|
||||
|
@ -109,8 +109,8 @@
|
||||
</method>
|
||||
<method name="GET" id="showSecGroupDefaultRule">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show default security group rule information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show default security group rule details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
security group rule.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -287,7 +287,7 @@
|
||||
<method name="DELETE" id="deleteSecGroupDefaultRule">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete default security group rule">
|
||||
<para role="shortdesc">Deletes a specified security group
|
||||
<para role="shortdesc">Deletes a security group
|
||||
rule.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults;
|
||||
|
@ -47,7 +47,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Create security group rule">
|
||||
<para role="shortdesc">
|
||||
Creates a rule for a specified security group.
|
||||
Creates a rule for a security group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -232,7 +232,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Delete security group rule">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified security group rule.
|
||||
Deletes a security group rule.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="202" />
|
||||
|
@ -53,8 +53,7 @@
|
||||
</method>
|
||||
<method name="GET" id="listSecGroupsByServer">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List security groups by server">
|
||||
<para role="shortdesc">Lists security groups for a
|
||||
specified server.</para>
|
||||
<para role="shortdesc">Lists security groups for a server.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
&securityGroupsObjectParameter;
|
||||
@ -67,8 +66,8 @@
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="showSecGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show security group information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show security group details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
security group.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -166,7 +165,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="deleteSecGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete security group">
|
||||
<para role="shortdesc">Deletes a specified security
|
||||
<para role="shortdesc">Deletes a security
|
||||
group.</para>
|
||||
</wadl:doc>
|
||||
<response status="202" />
|
||||
|
@ -38,7 +38,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Show server action details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified action and specified server.
|
||||
Shows details for an action and server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -55,7 +55,7 @@
|
||||
<wadl:doc xml:lang="EN" title="List actions for server"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Lists actions for a specified server.
|
||||
Lists actions for a server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
@ -44,7 +44,7 @@
|
||||
<method name="POST" id="attach">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Attach volume (attach action)">
|
||||
<para role="shortdesc">
|
||||
Attaches a specified volume to a specified server.
|
||||
Attaches a volume to a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>attach</code> action in the request body.
|
||||
@ -55,7 +55,7 @@
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>The specified server must exist.</para></listitem>
|
||||
<listitem><para>The server must exist.</para></listitem>
|
||||
<listitem><para>You can only attach a volume to the server
|
||||
when its status is <code>available</code>.</para></listitem>
|
||||
<listitem><para>The connection to the Block Storage service is valid.
|
||||
@ -124,7 +124,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Confirm resized server (confirmResize action)">
|
||||
<para role="shortdesc">
|
||||
Confirms a pending resize action for a specified server.
|
||||
Confirms a pending resize action for a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the
|
||||
@ -145,12 +145,12 @@
|
||||
is <code>VERIFY_RESIZED</code>, the vm_status is <code>RESIZED</code>,
|
||||
and the migration_status is <code>finished</code> or
|
||||
<code>confirming</code>.</para></listitem>
|
||||
<listitem><para>If the specified server is locked, you must have
|
||||
<listitem><para>If the server is locked, you must have
|
||||
administrator privileges to confirm the server.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>Troubleshooting</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>If the specified server status remains
|
||||
<listitem><para>If the server status remains
|
||||
<code>RESIZED</code>, 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.
|
||||
@ -173,7 +173,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create image (createImage action)">
|
||||
<para role="shortdesc">
|
||||
Creates an image from a specified server.
|
||||
Creates an image from a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>createImage</code> action in the request body.
|
||||
@ -191,7 +191,7 @@
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>The specified server must exist.</para></listitem>
|
||||
<listitem><para>The server must exist.</para></listitem>
|
||||
<listitem><para>You can only create a new image from the server
|
||||
when its status is <code>ACTIVE</code>, <code>SHUTOFF</code>,
|
||||
<code>PAUSED</code>, or <code>SUSPENDED</code>.</para></listitem>
|
||||
@ -237,7 +237,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Start server (os-start action)">
|
||||
<para role="shortdesc">
|
||||
Starts a specified stopped server and changes
|
||||
Starts a stopped server and changes
|
||||
its status to <code>ACTIVE</code>.
|
||||
</para>
|
||||
<para>
|
||||
@ -247,7 +247,7 @@
|
||||
<itemizedlist>
|
||||
<listitem><para>The server status must be <code>SHUTOFF</code>.
|
||||
</para></listitem>
|
||||
<listitem><para>If the specified server is locked, you
|
||||
<listitem><para>If the server is locked, you
|
||||
must have administrator privileges to start the server.
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
@ -299,7 +299,7 @@
|
||||
<listitem><para>The server status must be
|
||||
<code>ACTIVE</code> or <code>ERROR</code>.
|
||||
</para></listitem>
|
||||
<listitem><para>If the specified server is locked,
|
||||
<listitem><para>If the server is locked,
|
||||
you must have administrator privileges to stop
|
||||
the server.</para></listitem>
|
||||
</itemizedlist>
|
||||
@ -328,7 +328,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Reboot server (reboot action)">
|
||||
<para role="shortdesc">
|
||||
Reboots a specified server.
|
||||
Reboots a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>reboot</code> action in the request body.
|
||||
@ -348,13 +348,13 @@
|
||||
<method name="POST" id="rebuild">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Rebuild server (rebuild action)">
|
||||
<para role="shortdesc">
|
||||
Rebuilds a specified server.
|
||||
Rebuilds a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>rebuild</code> action in the request body.
|
||||
</para>
|
||||
<para>
|
||||
To rebuild the specified server with preservation of the
|
||||
To rebuild the server with preservation of the
|
||||
ephemeral partition, set the <code>preserve_ephemeral</code>
|
||||
parameter to <code>true</code>.
|
||||
</para>
|
||||
@ -386,7 +386,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Rescue server (rescue action)">
|
||||
<para role="shortdesc">
|
||||
Puts a specified server in rescue mode and changes its status to
|
||||
Puts a server in rescue mode and changes its status to
|
||||
<code>RESCUE</code>.
|
||||
</para>
|
||||
<para>
|
||||
@ -394,7 +394,7 @@
|
||||
</para>
|
||||
<para>
|
||||
If you specify the <code>rescue_image_ref</code> extended
|
||||
attribute, the specified image is used to rescue the instance.
|
||||
attribute, the image is used to rescue the instance.
|
||||
If you omit an image reference, the base image reference is
|
||||
used by default.
|
||||
</para>
|
||||
@ -477,7 +477,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Resize server (resize action)">
|
||||
<para role="shortdesc">
|
||||
Resizes a specified server.
|
||||
Resizes a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>resize</code> action in the request body.
|
||||
@ -500,7 +500,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If the specified server is locked, you must have
|
||||
If the server is locked, you must have
|
||||
administrator privileges to resize the server.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -521,7 +521,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Revert resized server (revertResize action)">
|
||||
<para role="shortdesc">
|
||||
Cancels and reverts a pending resize action for a specified server.
|
||||
Cancels and reverts a pending resize action for a server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>revertResize</code> action in the request
|
||||
@ -541,16 +541,16 @@
|
||||
<listitem><para>You can only confirm the resized server where the status
|
||||
is <code>VERIFY_RESIZE</code> and the vm_status is <code>RESIZED</code>.
|
||||
</para></listitem>
|
||||
<listitem><para>If the specified server is locked, you must have
|
||||
<listitem><para>If the server is locked, you must have
|
||||
administrator privileges to revert the resizing.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>Troubleshooting</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>If the specified server status remains
|
||||
<listitem><para>If the server status remains
|
||||
<code>RESIZED</code>, the request failed. Ensure you meet the
|
||||
preconditions and run the request again. If the request fails again,
|
||||
investigate the compute back end.</para></listitem>
|
||||
<listitem><para>The specified server is not reverted in the compute
|
||||
<listitem><para>The server is not reverted in the compute
|
||||
node that OpenStack Compute manages.</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -570,7 +570,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Unrescue server (unrescue action)">
|
||||
<para role="shortdesc">
|
||||
Unrescues a specified server. Changes status to
|
||||
Unrescues a server. Changes status to
|
||||
<code>ACTIVE</code>.
|
||||
</para>
|
||||
<para>
|
||||
@ -579,7 +579,7 @@
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>The specified server must exist.</para></listitem>
|
||||
<listitem><para>The server must exist.</para></listitem>
|
||||
<listitem><para>You can only unrescue a server
|
||||
when its status is <code>RESCUE</code>.</para></listitem>
|
||||
</itemizedlist>
|
||||
|
@ -95,7 +95,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List server groups">
|
||||
<para role="shortdesc">
|
||||
Lists all server groups for the specified tenant.
|
||||
Lists all server groups for the tenant.
|
||||
</para>
|
||||
<para>
|
||||
Administrative users can use the <code>all_projects</code>
|
||||
@ -117,7 +117,7 @@
|
||||
<para>
|
||||
If you specify a tenant ID for a non-administrative
|
||||
user with this query parameter, the call lists all
|
||||
server groups for the specified tenant, or project,
|
||||
server groups for the tenant, or project,
|
||||
rather than for all projects.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -138,7 +138,7 @@
|
||||
<method name="GET" id="showServerGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show server group details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
server group.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -155,7 +155,7 @@
|
||||
<method name="DELETE" id="deleteServerGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete server group">
|
||||
<para role="shortdesc">Deletes a specified server
|
||||
<para role="shortdesc">Deletes a server
|
||||
group.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
|
@ -32,7 +32,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get server password">
|
||||
<para role="shortdesc">Gets the administrative password
|
||||
for a specified server.</para>
|
||||
for a server.</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
or the owner of the server to perform this operation. Cloud providers can change
|
||||
|
@ -43,7 +43,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List services">
|
||||
<para role="shortdesc">
|
||||
Lists all services for a specified tenant. Includes reasons,
|
||||
Lists all services for a tenant. Includes reasons,
|
||||
if available, for why any disabled services were disabled.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -72,7 +72,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List disabled services">
|
||||
<para role="shortdesc">
|
||||
Lists disabled services for a specified tenant. Includes
|
||||
Lists disabled services for a tenant. Includes
|
||||
reasons, if available, for why disabled services were disabled.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -101,7 +101,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Enable scheduling for a service">
|
||||
<para role="shortdesc">
|
||||
Enables scheduling for a specified service.
|
||||
Enables scheduling for a service.
|
||||
</para>
|
||||
<para>
|
||||
Specify the service by its host name and binary name.
|
||||
@ -138,7 +138,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Disable scheduling for a service">
|
||||
<para role="shortdesc">
|
||||
Disables scheduling for a specified service.
|
||||
Disables scheduling for a service.
|
||||
</para>
|
||||
<para>
|
||||
Specify the service by its host name and binary name.
|
||||
@ -175,7 +175,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Log disabled service information">
|
||||
<para role="shortdesc">
|
||||
Logs information to the service table about why a specified
|
||||
Logs information to the service table about why a
|
||||
service was disabled.
|
||||
</para>
|
||||
<para>
|
||||
@ -215,8 +215,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Force down service">
|
||||
<para role="shortdesc">
|
||||
Forces down a specified service or unsets the forced-down
|
||||
state of a specified service.
|
||||
Forces down a service or unsets the forced-down
|
||||
state of a service.
|
||||
</para>
|
||||
<para>
|
||||
Specify the service by its host name and binary name.
|
||||
@ -254,7 +254,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete service">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified service.
|
||||
Deletes a service.
|
||||
</para>
|
||||
<para>
|
||||
Specify the service by its host name and binary name.
|
||||
|
@ -32,7 +32,7 @@
|
||||
<method name="POST" id="shelve">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Shelve server (shelve action)">
|
||||
<para role="shortdesc">Shelves a specified server.</para>
|
||||
<para role="shortdesc">Shelves a server.</para>
|
||||
<para>
|
||||
Specify the <code>shelve</code> action in the request
|
||||
body.
|
||||
@ -60,7 +60,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If the specified server is locked, you must have
|
||||
If the server is locked, you must have
|
||||
administrator privileges to shelve the server.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -115,7 +115,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Shelf-offload (remove) server (shelveOffload action)">
|
||||
<para role="shortdesc">
|
||||
Shelf-offloads, or removes, a specified shelved server.
|
||||
Shelf-offloads, or removes, a shelved server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>shelveOffload</code> action in the request body.
|
||||
@ -135,7 +135,7 @@
|
||||
<listitem><para>The server status must be
|
||||
<code>SHELVED</code>.</para></listitem>
|
||||
<listitem><para>
|
||||
If the specified server is locked, you must have
|
||||
If the server is locked, you must have
|
||||
administrator privileges to shelve-offload the server.
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
@ -172,7 +172,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Unshelve (restore) shelved server (unshelve action)">
|
||||
<para role="shortdesc">
|
||||
Unshelves, or restores, a specified shelved server.
|
||||
Unshelves, or restores, a shelved server.
|
||||
</para>
|
||||
<para>
|
||||
Specify the <code>unshelve</code> action in the request
|
||||
@ -189,7 +189,7 @@
|
||||
<listitem><para>The server status must be
|
||||
<code>SHELVED</code> or <code>SHELVED_OFFLOADED</code>.
|
||||
</para></listitem>
|
||||
<listitem><para>If the specified server is locked,
|
||||
<listitem><para>If the server is locked,
|
||||
you must have administrator privileges to unshelve
|
||||
the server.</para></listitem>
|
||||
</itemizedlist>
|
||||
|
@ -48,7 +48,7 @@
|
||||
<method name="GET" id="retrievetenantall">
|
||||
<wadl:doc xml:lang="EN" title="Show usage details for tenant"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows usage details for a specified
|
||||
<para role="shortdesc">Shows usage details for a
|
||||
tenant.</para>
|
||||
</wadl:doc>
|
||||
<request> </request>
|
||||
|
@ -96,8 +96,8 @@
|
||||
</method>
|
||||
<method name="GET" id="GetProjectNetwork">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show project network information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show project network details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
project network.
|
||||
</para>
|
||||
<para>
|
||||
@ -123,7 +123,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete project network">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified project network.
|
||||
Deletes a project network.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
|
@ -31,8 +31,7 @@
|
||||
<method name="GET" id="getVirtualInterfaces">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List virtual interfaces">
|
||||
<para role="shortdesc">Lists the virtual interfaces for a
|
||||
specified instance.</para>
|
||||
<para role="shortdesc">Lists the virtual interfaces for an instance.</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
or the owner of the server to perform this operation. Change
|
||||
|
@ -182,8 +182,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getVolumesDetail">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List details for volumes">
|
||||
<para role="shortdesc">Lists details for all volumes.</para>
|
||||
title="List volumes with details">
|
||||
<para role="shortdesc">Lists all volumes with details.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -198,8 +198,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getVolume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show volume information">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show volume details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
volume.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -216,7 +216,7 @@
|
||||
<method name="DELETE" id="deleteVolume">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete volume">
|
||||
<para role="shortdesc">Deletes a specified volume.</para>
|
||||
<para role="shortdesc">Deletes a volume.</para>
|
||||
</wadl:doc>
|
||||
<response status="202">
|
||||
<representation mediaType="application/json">
|
||||
@ -247,8 +247,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getVolumeType">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show volume type">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show volume type details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
volume type.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -268,7 +268,6 @@
|
||||
<para role="shortdesc">Creates a snapshot.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
@ -315,8 +314,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getSnapshotsDetail">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List details for snapshots">
|
||||
<para role="shortdesc">Lists details for all snapshots.</para>
|
||||
title="List snapshots with details">
|
||||
<para role="shortdesc">Lists all snapshots with details.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -331,8 +330,8 @@
|
||||
</method>
|
||||
<method name="GET" id="getSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show snapshot">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show snapshot details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
snapshot.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -349,7 +348,7 @@
|
||||
<method name="DELETE" id="deleteSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete snapshot">
|
||||
<para role="shortdesc">Deletes a specified snapshot from
|
||||
<para role="shortdesc">Deletes a snapshot from
|
||||
the account.</para>
|
||||
<para>This operation is asynchronous. You must list
|
||||
snapshots repeatedly to determine whether the snapshot
|
||||
|
@ -59,7 +59,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show IP details">
|
||||
<para role="shortdesc">
|
||||
Shows IP addresses details for a specified network label of a specified server instance.
|
||||
Shows IP addresses details for a network label of a server instance.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
|
@ -40,7 +40,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List all metadata">
|
||||
<para role="shortdesc">
|
||||
Lists all metadata for a specified server.
|
||||
Lists all metadata for a server.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
@ -68,7 +68,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update metadata items">
|
||||
<para role="shortdesc">
|
||||
Updates one or more metadata items for a specified
|
||||
Updates one or more metadata items for a
|
||||
server.
|
||||
</para>
|
||||
<para>
|
||||
@ -105,7 +105,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or replace metadata items">
|
||||
<para role="shortdesc">
|
||||
Creates or replaces one or more specified metadata items for a specified server.
|
||||
Creates or replaces one or more metadata items for a server.
|
||||
</para>
|
||||
<para>
|
||||
Creates any metadata items that do not already exist in the
|
||||
@ -143,8 +143,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metadata item details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified metadata item, by key, for a
|
||||
specified server.
|
||||
Shows details for a metadata item, by key, for a
|
||||
server.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
@ -172,7 +172,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create or update metadata item">
|
||||
<para role="shortdesc">
|
||||
Creates or replaces a specified metadata item, by key, for a specified server.
|
||||
Creates or replaces a metadata item, by key, for a server.
|
||||
</para>
|
||||
<para>
|
||||
Creates a metadata item that does not already exist in the
|
||||
@ -210,7 +210,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete metadata item">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified metadata item, by key, from a specified server.
|
||||
Deletes a metadata item, by key, from a server.
|
||||
</para>
|
||||
<para>
|
||||
Policy defaults enable only users with the administrative role
|
||||
|
@ -23,9 +23,11 @@
|
||||
<param name="accountId" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The account ID of the
|
||||
owner of the specified
|
||||
instance.</para></wadl:doc>
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The account ID of the owner of the instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<!-- add later when trove extensions are supported -->
|
||||
<!--<resource id="extensions" type="#ExtensionList"
|
||||
@ -56,7 +58,7 @@
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The instance ID for the specified database
|
||||
The instance ID for the database
|
||||
instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -81,7 +83,7 @@
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The name for
|
||||
the specified
|
||||
the
|
||||
database.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#deleteDatabase"/>
|
||||
@ -96,7 +98,7 @@
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The name for
|
||||
the specified
|
||||
the
|
||||
user.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#deleteUser"/>
|
||||
@ -116,7 +118,7 @@
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>The flavor ID for
|
||||
the specified
|
||||
the
|
||||
flavor.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getFlavorById"/>
|
||||
@ -129,7 +131,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The name of the datastore whose versions
|
||||
The name of the data store whose versions
|
||||
you want to list.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -244,11 +246,10 @@
|
||||
Creates a database instance.
|
||||
</para>
|
||||
<para>
|
||||
This operation asynchronously provisions a new database
|
||||
instance. This call requires the user to specify a flavor and
|
||||
a volume size. The service then provisions the instance with
|
||||
the requested flavor and sets up a volume of the specified
|
||||
size, which is the storage for the database instance.
|
||||
Asynchronously provisions a new database instance. You must
|
||||
specify a flavor and a volume size. The service provisions the
|
||||
instance with a volume of the requested size, which serves as
|
||||
storage for the database instance.
|
||||
</para>
|
||||
<note>
|
||||
<title>Notes</title>
|
||||
@ -407,7 +408,7 @@
|
||||
<method name="DELETE" id="deleteInstance">
|
||||
<wadl:doc xml:lang="EN" title="Delete database instance"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Deletes a specified database
|
||||
role="shortdesc">Deletes a database
|
||||
instance, including any associated data.</para>
|
||||
<note><para>This operation does not delete any read
|
||||
slaves.</para></note>
|
||||
@ -482,7 +483,7 @@
|
||||
Shows database instance details.
|
||||
</para>
|
||||
<para>
|
||||
Lists the status and details of the specified database
|
||||
Lists the status and details of the database
|
||||
instance.
|
||||
</para>
|
||||
<para>
|
||||
@ -539,7 +540,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Restart instance"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Restarts the database service for a specified instance.
|
||||
Restarts the database service for a instance.
|
||||
</para>
|
||||
<para>
|
||||
The restart operation restarts only the MySQL instance.
|
||||
@ -661,15 +662,24 @@
|
||||
<!-- Database -->
|
||||
<method name="POST" id="createDatabase">
|
||||
<wadl:doc xml:lang="EN" title="Create database"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Creates a database within a specified
|
||||
instance.</para><para>This operation creates a new
|
||||
database within the specified
|
||||
instance.</para><para>The <code>name</code> of the
|
||||
database is a required attribute.</para><para>The
|
||||
following additional attributes can be specified for
|
||||
each database: <code>collate</code> and
|
||||
<code>character_set</code>.</para><table
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para
|
||||
role="shortdesc">
|
||||
Creates a database within an
|
||||
instance.
|
||||
</para>
|
||||
<para>This operation creates a new
|
||||
database within an instance.
|
||||
</para>
|
||||
<para>
|
||||
The <code>name</code> of the
|
||||
database is a required attribute.
|
||||
</para>
|
||||
<para>
|
||||
You can specify these additional attributes for each database:
|
||||
<code>collate</code> and <code>character_set</code>.
|
||||
</para>
|
||||
<table
|
||||
rules="all">
|
||||
<caption>Required and optional attributes for creating a database</caption>
|
||||
<thead>
|
||||
@ -703,17 +713,27 @@
|
||||
<code>utf8_general_ci</code>.</td>
|
||||
<td colspan="1">No</td>
|
||||
</tr>
|
||||
</tbody></table><para>See the MySQL documentation for
|
||||
information about supported character sets and
|
||||
collations at <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html"
|
||||
>http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html</link>.</para><note><para>The
|
||||
following database names are reserved and cannot
|
||||
be used for creating databases: lost+found,
|
||||
information_schema, and
|
||||
mysql.</para></note><para>See the following tables for
|
||||
information about characters that are valid/invalid
|
||||
for creating database names.</para><table rules="all"
|
||||
</tbody>
|
||||
</table>
|
||||
<para>
|
||||
For information about supported character sets and collations,
|
||||
see the MySQL documentation at <link
|
||||
xlink:href="http://dev.mysql.com/doc/refman/5.1/en/charset-mysql.html">Character
|
||||
Sets and Collations in MySQL</link>.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
The <code>lost+found</code>,
|
||||
<code>information_schema</code>, and <code>mysql</code>
|
||||
database names are reserved and cannot be used to create
|
||||
databases.
|
||||
</para>
|
||||
</note>
|
||||
<para>
|
||||
See the following tables for information about characters that
|
||||
are valid for creating database names.
|
||||
</para>
|
||||
<table rules="all"
|
||||
width="40%">
|
||||
<caption>Valid characters in a database name</caption>
|
||||
<col width="100%"/>
|
||||
@ -766,10 +786,10 @@
|
||||
<td>Commas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Backslashes</td>
|
||||
<td>Back slashes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Forwardslashes</td>
|
||||
<td>Forward slashes</td>
|
||||
</tr>
|
||||
</tbody></table><table rules="all">
|
||||
<caption>Length restrictions for database name</caption>
|
||||
@ -812,10 +832,9 @@
|
||||
<method name="GET" id="getDatabases">
|
||||
<wadl:doc xml:lang="EN" title="List instance databases"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Lists databases for a specified
|
||||
instance.</para><para>This operation lists the
|
||||
databases for the specified
|
||||
instance.</para><note><para>This operation returns
|
||||
role="shortdesc">Lists databases for an
|
||||
instance.</para>
|
||||
<note><para>This operation returns
|
||||
only the user-defined databases, not the system
|
||||
databases. The system databases (mysql,
|
||||
information_schema, lost+found) can only be viewed
|
||||
@ -847,10 +866,9 @@
|
||||
<method name="DELETE" id="deleteDatabase">
|
||||
<wadl:doc xml:lang="EN" title="Delete database"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Deletes a specified
|
||||
database.</para><para>This operation deletes the
|
||||
requested database within the specified database
|
||||
instance. Note that all data associated with the
|
||||
role="shortdesc">Deletes a
|
||||
database.</para>
|
||||
<para>Note that all data associated with the
|
||||
database is also deleted.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -877,20 +895,20 @@
|
||||
<method name="POST" id="createUser">
|
||||
<wadl:doc xml:lang="EN" title="Create user"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Creates a user for a specified
|
||||
database instance.</para><para>This operation
|
||||
asynchronously provisions a new user for the specified
|
||||
role="shortdesc">Creates a user for a
|
||||
database instance.</para>
|
||||
<para>Asynchronously provisions a new user for the
|
||||
database instance based on the configuration defined
|
||||
in the request object. Once the request is validated
|
||||
and progress has started on the provisioning process,
|
||||
in the request object. After the request is validated
|
||||
and progress begins on the provisioning process,
|
||||
a 202 Accepted response object is returned.</para>
|
||||
<remark>Writer: please add the following note back into
|
||||
<!-- <remark>Writer: please add the following note back into
|
||||
the doc once the list User details call is added back
|
||||
into the API: Using the identifier, the caller can
|
||||
check on the progress of the operation by performing a
|
||||
GET on users/name (for more details on this operation
|
||||
see the "List User details" section of this
|
||||
document).</remark>
|
||||
document).</remark> -->
|
||||
<para>If the corresponding request cannot be fulfilled due
|
||||
to insufficient or invalid data, an HTTP 400 "Bad
|
||||
Request" error response is returned with information
|
||||
@ -928,9 +946,8 @@
|
||||
<tr>
|
||||
<td colspan="1">(database) name</td>
|
||||
<td colspan="2"><para>Name of the database
|
||||
that the user can access. One or more
|
||||
database names must be
|
||||
specified.</para></td>
|
||||
that the user can access. You must specify one or more
|
||||
database names.</para></td>
|
||||
<td colspan="1">No</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -1001,10 +1018,10 @@
|
||||
<td>Commas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Backslashes</td>
|
||||
<td>Back slashes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Forwardslashes</td>
|
||||
<td>Forward slashes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Spaces at the front or end of the user
|
||||
@ -1056,17 +1073,20 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="getUsers">
|
||||
<wadl:doc xml:lang="EN" title="List database instance users"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Lists the users in a specified
|
||||
database instance.</para><para>This operation lists
|
||||
the users in the specified database instance, along
|
||||
with the associated databases for that
|
||||
user.</para><note><para>This operation does not
|
||||
return the system users (database administrators
|
||||
that administer the health of the database). Also,
|
||||
this operation returns the "root" user only if
|
||||
"root" user has been
|
||||
enabled.</para></note><para>The following notes apply
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Lists the users in a database instance, along with the
|
||||
associated databases for that user.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This operation does not return the system users (database
|
||||
administrators that administer the health of the
|
||||
database). Also, this operation returns the "root" user
|
||||
only if "root" user is enabled.
|
||||
</para>
|
||||
</note>
|
||||
<para>The following notes apply
|
||||
to MySQL users:</para><itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>User names can be up to 16 characters
|
||||
@ -1108,12 +1128,10 @@
|
||||
<method name="DELETE" id="deleteUser">
|
||||
<wadl:doc xml:lang="EN" title="Delete user"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Deletes a specified user for a
|
||||
specified database instance.</para><para>This
|
||||
operation deletes the specified user for the specified
|
||||
database instance.</para>
|
||||
<warning><para>There is a bug in a python library that
|
||||
Rackspace is using that may cause incorrect user
|
||||
role="shortdesc">Deletes a user for a
|
||||
database instance.</para>
|
||||
<warning><para>There is a bug in a Python library that
|
||||
Rackspace is using that can cause incorrect user
|
||||
deletions to occur if a period (.) is used in the
|
||||
user name. In this case, the user name is
|
||||
truncated to remove the portion of the name from
|
||||
@ -1149,24 +1167,24 @@
|
||||
<method name="POST" id="createRoot">
|
||||
<wadl:doc xml:lang="EN" title="Enable root user"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Enables the root user for a specified
|
||||
role="shortdesc">Enables the root user for a
|
||||
database instance and returns the root
|
||||
password.</para><para>This operation enables login
|
||||
from any host for the root user and provides the user
|
||||
with a generated root password.</para>
|
||||
<note><para>Changes you make as a root user may cause
|
||||
detrimental effects to the database instance and
|
||||
unpredictable behavior for API operations. When
|
||||
you enable the root user, you accept the
|
||||
possibility that we will not be able to support
|
||||
your database instance. While enabling root does
|
||||
not prevent us from a “best effort” approach to
|
||||
helping you if something goes wrong with your
|
||||
instance, we cannot ensure that we will be able to
|
||||
assist you if you change core MySQL settings.
|
||||
These changes can be (but are not limited to)
|
||||
turning off binlogs, removing users that we use to
|
||||
access your instance, and so forth.</para></note>
|
||||
<note>
|
||||
<para>
|
||||
Changes that you make as a root user can have detrimental
|
||||
effects on the database instance and unpredictable
|
||||
behavior for API operations. When you enable the root
|
||||
user, you accept the possibility that we will not be able
|
||||
to support your database instance. We may not be able to
|
||||
assist you if you change core MySQL settings. These
|
||||
changes can be, but are not limited to, turning off bin
|
||||
logs, removing users that we use to access your instance,
|
||||
and so on.
|
||||
</para>
|
||||
</note>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -1195,14 +1213,13 @@
|
||||
<wadl:doc xml:lang="EN"
|
||||
title="Show root-enabled status for database instance"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows root-enabled status for a
|
||||
database instance.</para>
|
||||
<para>Returns true if root user is enabled for a specified
|
||||
database instance or false otherwise.</para>
|
||||
<para>This operation checks an active specified database
|
||||
instance to see if root access is enabled. It returns
|
||||
True if root user is enabled for the specified
|
||||
database instance or False otherwise.</para>
|
||||
<para role="shortdesc">
|
||||
Shows root-enabled status for a database instance.
|
||||
</para>
|
||||
<para>
|
||||
Returns <code>true</code> if root user is enabled for a
|
||||
database instance. Otherwise, returns <code>false</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -1267,11 +1284,9 @@
|
||||
<method name="GET" id="getFlavorById">
|
||||
<wadl:doc xml:lang="EN" title="Show flavor details"
|
||||
xmlns="http://docbook.org/ns/docbook"><para
|
||||
role="shortdesc">Shows flavor details.</para>
|
||||
<para>This operation lists all information for the
|
||||
specified flavor ID with details of the RAM.</para>
|
||||
role="shortdesc">Shows flavor details with details of the RAM.</para>
|
||||
<para>This resource is identical to the flavors found in
|
||||
the OpenStack Nova API, but without the disk
|
||||
the OpenStack Compute API, but without the disk
|
||||
property.</para>
|
||||
<note><para>The flavorId parameter should be an integer.
|
||||
If a floating point value is used for the flavorId
|
||||
@ -1311,7 +1326,7 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Lists the available versions of
|
||||
a specified datastore.
|
||||
a data store.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1341,8 +1356,8 @@
|
||||
<wadl:doc xml:lang="EN" title="List configuration parameters"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Lists the available configuration parameters for a specified
|
||||
datastore version.
|
||||
Lists the available configuration parameters for a
|
||||
data store version.
|
||||
</para>
|
||||
<para>
|
||||
Parameter information includes the type, minimum and maximum
|
||||
@ -1378,7 +1393,7 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Displays details for a configuration parameter associated
|
||||
with a specified datastore version.
|
||||
with a data store version.
|
||||
</para>
|
||||
<para>
|
||||
Details include the type, minimum and maximum
|
||||
@ -1430,7 +1445,8 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Datastore assigned to the configuration group. Required if default datastore is not configured.
|
||||
Data store assigned to the configuration group.
|
||||
Required if default data store is not configured.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -1475,7 +1491,7 @@
|
||||
Lists all configuration groups.
|
||||
</para>
|
||||
<para>
|
||||
The list includes the associated datastore and datastore
|
||||
The list includes the associated data store and data store
|
||||
version for each configuration group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1506,8 +1522,8 @@
|
||||
<wadl:doc xml:lang="EN" title="List configuration defaults"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Lists the configuration defaults for a
|
||||
specified instance.
|
||||
Lists the configuration defaults for an
|
||||
instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1538,7 +1554,7 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Attaches a configuration group to
|
||||
a specified instance.
|
||||
a instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1577,12 +1593,12 @@
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Detaches a configuration group from
|
||||
a specified instance.
|
||||
a instance.
|
||||
</para>
|
||||
<para>
|
||||
When you pass in only an instance ID (no configuration ID),
|
||||
this operation detaches whatever configuration group
|
||||
was attached to the specified instance.
|
||||
When you pass in only an instance ID and omit the configuration ID,
|
||||
this operation detaches any configuration group
|
||||
that was attached to the instance.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -167,7 +167,7 @@
|
||||
<method name="PATCH" id="clusters-update">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update cluster">
|
||||
<para role="shortdesc">Updates a specified cluster.</para>
|
||||
<para role="shortdesc">Updates a cluster.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -54,7 +54,7 @@
|
||||
<method name="GET" id="dataSourceInfo">
|
||||
<wadl:doc xml:lang="EN" title="Show data source details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified data source.</para>
|
||||
<para role="shortdesc">Shows details for a data source.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -112,14 +112,14 @@
|
||||
<method name="DELETE" id="dataSourceDelete">
|
||||
<wadl:doc xml:lang="EN" title="Delete data source"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Deletes a specified data source.</para>
|
||||
<para role="shortdesc">Deletes a data source.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="PUT" id="dataSourceUpdate">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update data source">
|
||||
<para role="shortdesc">Updates a specified data source.</para>
|
||||
<para role="shortdesc">Updates a data source.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -71,7 +71,7 @@
|
||||
<method name="GET" id="imageInfo">
|
||||
<wadl:doc xml:lang="EN" title="Show image details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details about a specified image.</para>
|
||||
<para role="shortdesc">Shows details about a image.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -87,7 +87,7 @@
|
||||
<method name="POST" id="imageReg">
|
||||
<wadl:doc xml:lang="EN" title="Register image"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Registers a specified image in the image registry.</para>
|
||||
<para role="shortdesc">Registers a image in the image registry.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -99,8 +99,10 @@
|
||||
</wadl:doc>
|
||||
<param name="username" style="plain" type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Username to login into an instance’s OS for
|
||||
remote operations execution.</para>
|
||||
<para>
|
||||
The user name to log in to an instance OS for
|
||||
remote operations execution.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="description" style="plain" type="xsd:string">
|
||||
@ -124,14 +126,14 @@
|
||||
<method name="DELETE" id="imageUnreg">
|
||||
<wadl:doc xml:lang="EN" title="Unregister image"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Removes a specified image from the image registry.</para>
|
||||
<para role="shortdesc">Removes a image from the image registry.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="POST" id="addTags">
|
||||
<wadl:doc xml:lang="EN" title="Add tags to image"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Adds tags to a specified image.</para>
|
||||
<para role="shortdesc">Adds tags to a image.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -162,7 +164,7 @@
|
||||
<method name="POST" id="removeTags">
|
||||
<wadl:doc xml:lang="EN" title="Remove tags from image"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Removes tags from a specified image.</para>
|
||||
<para role="shortdesc">Removes tags from a image.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -91,7 +91,7 @@
|
||||
<method name="GET" id="job-binaries-show">
|
||||
<wadl:doc xml:lang="EN" title="Show job binary details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
job binary.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -107,14 +107,14 @@
|
||||
<method name="DELETE" id="job-binaries-delete">
|
||||
<wadl:doc xml:lang="EN" title="Delete job binary"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Deletes a specified job binary.</para>
|
||||
<para role="shortdesc">Deletes a job binary.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="GET" id="job-binaries-data">
|
||||
<wadl:doc xml:lang="EN" title="Get job binary data"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Gets data for a specified job
|
||||
<para role="shortdesc">Gets data for a job
|
||||
binary.</para>
|
||||
<para>The response body shows the job binary raw data and
|
||||
the response headers show the data length.</para>
|
||||
@ -145,7 +145,7 @@ store B into '$OUTPUT' USING PigStorage();</programlisting></para>
|
||||
<method name="PUT" id="job-binaries-update">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update job binary">
|
||||
<para role="shortdesc">Updates a specified job binary.</para>
|
||||
<para role="shortdesc">Updates a job binary.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -103,7 +103,7 @@
|
||||
<method name="GET" id="job-binary-internals-show">
|
||||
<wadl:doc xml:lang="EN" title="Show job binary internal details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
job binary internal.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -119,7 +119,7 @@
|
||||
<method name="DELETE" id="job-binary-internals-delete">
|
||||
<wadl:doc xml:lang="EN" title="Delete job binary internal"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Deletes a specified job binary
|
||||
<para role="shortdesc">Deletes a job binary
|
||||
internal.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -127,7 +127,7 @@
|
||||
<method name="GET" id="job-binary-internals-data">
|
||||
<wadl:doc xml:lang="EN" title="Get job binary internal data"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Gets data for a specified job
|
||||
<para role="shortdesc">Gets data for a job
|
||||
binary internal.</para>
|
||||
<para>The response body shows the job binary raw data and
|
||||
the response headers show the data length.</para>
|
||||
@ -158,7 +158,7 @@ store B into '$OUTPUT' USING PigStorage(); </programlisting></para>
|
||||
<method name="PATCH" id="job-binary-internals-update">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update job binary internal">
|
||||
<para role="shortdesc">Updates a specified job binary internal.</para>
|
||||
<para role="shortdesc">Updates a job binary internal.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -74,7 +74,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Show job execution details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified job execution, by ID.
|
||||
Shows details for a job execution, by ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -91,7 +91,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Refresh job execution status"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Refreshes the status of and shows information for a specified
|
||||
Refreshes the status of and shows information for a
|
||||
job execution.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -109,7 +109,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Cancel job execution"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Cancels a specified job execution.
|
||||
Cancels a job execution.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -126,7 +126,7 @@
|
||||
<wadl:doc xml:lang="EN" title="Delete job execution"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified job execution.
|
||||
Deletes a job execution.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -134,7 +134,7 @@
|
||||
<method name="PATCH" id="job-executions-update">
|
||||
<wadl:doc xml:lang="EN" title="Update job execution"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Updates a specified job execution.</para>
|
||||
<para role="shortdesc">Updates a job execution.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -27,7 +27,12 @@
|
||||
<method name="GET" id="jobTypesList">
|
||||
<wadl:doc xml:lang="EN" title="List job types"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists job types filtered by specified filter parameters.</para>
|
||||
<para role="shortdesc">
|
||||
Lists job types.
|
||||
</para>
|
||||
<para>
|
||||
You can filter the response through filter parameters.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -57,7 +57,7 @@
|
||||
<method name="GET" id="jobInfo">
|
||||
<wadl:doc xml:lang="EN" title="Show job details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows details for a specified job.</para>
|
||||
<para role="shortdesc">Shows details for a job.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -99,14 +99,14 @@
|
||||
<method name="DELETE" id="jobDelete">
|
||||
<wadl:doc xml:lang="EN" title="Remove job"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Removes a specified job.</para>
|
||||
<para role="shortdesc">Removes a job.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="POST" id="jobExecute">
|
||||
<wadl:doc xml:lang="EN" title="Run job"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Runs a specified job.</para>
|
||||
<para role="shortdesc">Runs a job.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -132,7 +132,7 @@
|
||||
<method name="PATCH" id="jobUpdate">
|
||||
<wadl:doc xml:lang="EN" title="Update job object"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Updates a specified job object.</para>
|
||||
<para role="shortdesc">Updates a job object.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -63,7 +63,7 @@
|
||||
<method name="GET" id="node-group-templates-get">
|
||||
<wadl:doc xml:lang="EN" title="Show node group template details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows a specified node group template, by ID.</para>
|
||||
<para role="shortdesc">Shows a node group template, by ID.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
@ -105,14 +105,14 @@
|
||||
<method name="DELETE" id="node-group-templates-delete">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete node group template">
|
||||
<para role="shortdesc">Deletes a specified node group template.</para>
|
||||
<para role="shortdesc">Deletes a node group template.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="PUT" id="node-group-templates-update">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update node group template">
|
||||
<para role="shortdesc">Updates a specified node group template.</para>
|
||||
<para role="shortdesc">Updates a node group template.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -57,9 +57,9 @@
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="pluginsget">
|
||||
<wadl:doc xml:lang="EN" title="Show plugin information"
|
||||
<wadl:doc xml:lang="EN" title="Show plugin details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
plugin.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -74,10 +74,10 @@
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="pluginsgetversion">
|
||||
<wadl:doc xml:lang="EN" title="Show detailed plugin information"
|
||||
<wadl:doc xml:lang="EN" title="Show plugin version details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows detailed information for a specified
|
||||
plugin.</para>
|
||||
<para role="shortdesc">Shows details for a
|
||||
plugin version.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
|
@ -181,7 +181,7 @@
|
||||
<method name="POST" id="createTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Create tenant">
|
||||
<para role="shortdesc">Creates a specified tenant.</para>
|
||||
<para role="shortdesc">Creates a tenant.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -205,7 +205,7 @@
|
||||
<method name="POST" id="updateTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update tenant">
|
||||
<para role="shortdesc">Updates a specified tenant.</para>
|
||||
<para role="shortdesc">Updates a tenant.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -228,14 +228,14 @@
|
||||
<method name="DELETE" id="deleteTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete tenant">
|
||||
<para role="shortdesc">Deletes a specified tenant.</para>
|
||||
<para role="shortdesc">Deletes a tenant.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="listUsersForTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List users on a tenant">
|
||||
<para role="shortdesc">
|
||||
Lists all users for a specified tenant.
|
||||
Lists all users for a tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -253,16 +253,16 @@
|
||||
<method name="PUT" id="grantRoleToUserOnTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Grant roles to user on tenant">
|
||||
<para role="shortdesc">Grants a specified role to a specified user for
|
||||
a specified tenant.</para>
|
||||
<para role="shortdesc">Grants a role to a user for
|
||||
a tenant.</para>
|
||||
</wadl:doc>
|
||||
<response status="201"/> &commonFaults; &postPutFaults;
|
||||
&getFaults; </method>
|
||||
<method name="DELETE" id="revokeRoleFromUserOnTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Revoke role from user on tenant">
|
||||
<para role="shortdesc">Revokes a specified role from a
|
||||
specified user for a specified tenant.</para>
|
||||
<para role="shortdesc">Revokes a role from a
|
||||
user for a tenant.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<!-- User Operations -->
|
||||
@ -309,7 +309,7 @@
|
||||
<method name="PUT" id="updateUser">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update user">
|
||||
<para role="shortdesc">Updates a specified user.</para>
|
||||
<para role="shortdesc">Updates a user.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -330,13 +330,13 @@
|
||||
<method name="DELETE" id="deleteUser">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete user">
|
||||
<para role="shortdesc">Deletes a specified user.</para>
|
||||
<para role="shortdesc">Deletes a user.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<method name="PUT" id="enableUser">
|
||||
<wadl:doc xml:lang="EN" title="Enable user"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Enables a specified user.</para>
|
||||
<para role="shortdesc">Enables a user.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -360,7 +360,7 @@
|
||||
<method name="GET" id="listUserRoles">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List global roles for user">
|
||||
<para role="shortdesc">Lists global roles for a specified
|
||||
<para role="shortdesc">Lists global roles for a
|
||||
user.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -379,16 +379,16 @@
|
||||
<method name="PUT" id="grantGlobalRoleToUser">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Grant global role to user">
|
||||
<para role="shortdesc">Grants a specified global role to a
|
||||
specified user.</para>
|
||||
<para role="shortdesc">Grants a global role to a
|
||||
user.</para>
|
||||
</wadl:doc>
|
||||
<response status="201"/> &commonFaults; &postPutFaults;
|
||||
&getFaults; </method>
|
||||
<method name="DELETE" id="revokeGlobalRoleFromUser">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete global role from user">
|
||||
<para role="shortdesc">Deletes a specified global role from
|
||||
a specified user.</para>
|
||||
<para role="shortdesc">Deletes a global role from
|
||||
a user.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<!-- Roles -->
|
||||
@ -449,7 +449,7 @@
|
||||
<method name="GET" id="showRoleByName">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show role information by name">
|
||||
<para role="shortdesc">Shows information for a specified role, by name.</para>
|
||||
<para role="shortdesc">Shows information for a role, by name.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
@ -465,8 +465,8 @@
|
||||
</response> &commonFaults; &postPutFaults; &getFaults; </method>
|
||||
<method name="GET" id="showRoleByID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show role information by ID">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show role details, by ID">
|
||||
<para role="shortdesc">Shows details for a
|
||||
role, by ID.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -484,7 +484,7 @@
|
||||
<method name="DELETE" id="deleteRole">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete role">
|
||||
<para role="shortdesc">Deletes a specified role.</para>
|
||||
<para role="shortdesc">Deletes a role.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<!-- Service Operations -->
|
||||
@ -508,7 +508,7 @@
|
||||
<method name="GET" id="showServiceByName">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show service information by name">
|
||||
<para role="shortdesc">Shows information for a specified service, by name.</para>
|
||||
<para role="shortdesc">Shows information for a service, by name.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
@ -522,7 +522,7 @@
|
||||
<method name="GET" id="showServiceByID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Shows service information by ID">
|
||||
<para role="shortdesc">Shows information for a specified service, by ID.</para>
|
||||
<para role="shortdesc">Shows information for a service, by ID.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json">
|
||||
@ -564,7 +564,7 @@
|
||||
<method name="DELETE" id="deleteService">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete service">
|
||||
<para role="shortdesc">Deletes a specified service.</para>
|
||||
<para role="shortdesc">Deletes a service.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
</application>
|
||||
|
@ -88,7 +88,7 @@
|
||||
<method name="POST" id="grantCredentialToUser">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Grant credential to user">
|
||||
<para role="shortdesc">Grants a specified credential to a specified user.</para>
|
||||
<para role="shortdesc">Grants a credential to a user.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json" element="ec2Credentials">
|
||||
@ -149,7 +149,7 @@
|
||||
<method name="POST" id="updateUserCredential">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update user credentials">
|
||||
<para role="shortdesc">Updates credentials for a specified
|
||||
<para role="shortdesc">Updates credentials for a
|
||||
user.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -87,7 +87,7 @@
|
||||
<method name="POST" id="grantCredentialToUser">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Grant credential to user">
|
||||
<para role="shortdesc">Grants a specified credential to a specified user.</para>
|
||||
<para role="shortdesc">Grants a credential to a user.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json" element="s3credentials">
|
||||
|
@ -50,9 +50,11 @@
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN"><para>A valid
|
||||
authentication
|
||||
token.</para></wadl:doc>
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A valid authentication token.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="belongsTo" style="query"
|
||||
required="false" type="xsd:string">
|
||||
@ -60,13 +62,12 @@
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Validates that a token has the specified
|
||||
tenant in scope, for performance. Valid
|
||||
tokens are in the
|
||||
<code>/tokens/{tokenId}</code> path. If
|
||||
the token is not valid, this call throws
|
||||
the <code> itemNotFound (404)</code>
|
||||
fault.
|
||||
Validates that a token has the tenant in
|
||||
scope, for performance. Valid tokens are in
|
||||
the <code>/tokens/{tokenId}</code> path. If
|
||||
the token is not valid, this call returns
|
||||
the <code>itemNotFound (404)</code> response
|
||||
code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -109,14 +110,14 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Validate token">
|
||||
<para role="shortdesc">
|
||||
Checks that a token is valid and that it belongs to a
|
||||
specified tenant and any specified service IDs. Returns the
|
||||
permissions for a particular client.
|
||||
Checks that a token is valid and that it belongs to the tenant
|
||||
and any service IDs. Returns the permissions for a particular
|
||||
client.
|
||||
</para>
|
||||
<para>
|
||||
Behavior is similar to <code>/tokens/{tokenId}</code>. If the
|
||||
token is not valid, the call throws the <code>itemNotFound
|
||||
(404)</code> fault.
|
||||
token is not valid, the call returns the <code>itemNotFound
|
||||
(404)</code> response code.
|
||||
</para>
|
||||
<para>
|
||||
This extension might decrypt the <code>X-Subject-Token</code>
|
||||
@ -141,13 +142,13 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Check token">
|
||||
<para role="shortdesc">
|
||||
Checks that a token is valid and that it belongs to a
|
||||
specified tenant and any specified service IDs, for performance.
|
||||
Checks that a token is valid and that it belongs to the tenant
|
||||
and any service IDs, for performance.
|
||||
</para>
|
||||
<para>
|
||||
Behavior is similar to <code>/tokens/{tokenId}</code>. If the
|
||||
token is not valid, the call throws the <code>itemNotFound
|
||||
(404)</code> fault.
|
||||
token is not valid, the call returns the <code>itemNotFound
|
||||
(404)</code> response code.
|
||||
</para>
|
||||
<para>
|
||||
This extension might decrypt the <code>X-Subject-Token</code>
|
||||
@ -163,7 +164,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List endpoints for token">
|
||||
<para role="shortdesc">Lists endpoints associated with a
|
||||
specified token.</para>
|
||||
token.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
&limitMarkerReqParameter;
|
||||
|
@ -94,9 +94,9 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
One or more service IDs. Specify multiple values as a comma-separated
|
||||
list. The API checks roles against the specified service IDs. If a
|
||||
service ID is not valid or no roles are associated with it, this call
|
||||
throws the <code>unauthorized (401)</code> fault.
|
||||
list. The API checks roles against the service IDs. If a service ID is
|
||||
not valid or no roles are associated with it, this call returns the
|
||||
<code>unauthorized (401)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
@ -90,7 +90,7 @@
|
||||
required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Validates that a token has the specified
|
||||
Validates that a token has a
|
||||
tenant in scope, for performance. Valid tokens
|
||||
are in the <code>/tokens/{tokenId}</code>
|
||||
path. If the token is not valid, this call
|
||||
@ -105,10 +105,9 @@
|
||||
<para>
|
||||
The tenant name. The <code>tenantId</code> and
|
||||
<code>tenantName</code> attributes are
|
||||
optional but should not be specified together.
|
||||
If you specify both attributes, the call
|
||||
returns the <code>Bad Request (400)</code>
|
||||
response code.
|
||||
optional and mutually exclusive. If you
|
||||
specify both attributes, the call returns the
|
||||
<code>Bad Request (400)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -118,10 +117,9 @@
|
||||
<para>
|
||||
The tenant ID. The <code>tenantId</code> and
|
||||
<code>tenantName</code> attributes are
|
||||
optional but should not be specified together.
|
||||
If you specify both attributes, the call
|
||||
returns the <code>Bad Request (400)</code>
|
||||
response code.
|
||||
optional and mutually exclusive. If you
|
||||
specify both attributes, the call returns the
|
||||
<code>Bad Request (400)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -276,7 +274,7 @@
|
||||
<method name="GET" id="admin-getVersionInfo">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Get version details">
|
||||
<para>
|
||||
Gets detailed information about a specified version of the Identity API.
|
||||
Gets detailed information about a version of the Identity API.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -325,7 +323,7 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="admin-getExtension-v2.0">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Get extension details">
|
||||
<para role="shortdesc">Gets detailed information for a specified extension.</para>
|
||||
<para role="shortdesc">Gets detailed information for a extension.</para>
|
||||
<para>Specify the extension alias in the URI.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -363,7 +361,7 @@
|
||||
HTTP <code>unauthorized (401)</code> response code.
|
||||
</para>
|
||||
<para>
|
||||
If the token specified in the request body has expired, this
|
||||
If the token has expired, this
|
||||
call returns the <code>itemNotFound (404)</code> response
|
||||
code.
|
||||
</para>
|
||||
@ -532,7 +530,7 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="admin-validateToken">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Validate token">
|
||||
<para role="shortdesc">Validates a token and confirms that it belongs to a specified
|
||||
<para role="shortdesc">Validates a token and confirms that it belongs to a
|
||||
tenant.</para>
|
||||
<para>
|
||||
Returns the permissions relevant to a particular client. Valid
|
||||
@ -552,20 +550,20 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="HEAD" id="admin-checkToken">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Validate token (admin)">
|
||||
<para role="shortdesc">Validates a token and confirms that it belongs to a specified
|
||||
<para role="shortdesc">Validates a token and confirms that it belongs to a
|
||||
tenant, for performance.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203 204"/> &commonFaults; &getFaults; </method>
|
||||
<method name="DELETE" id="admin-deleteToken">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete token">
|
||||
<para role="shortdesc">Deletes a specified token.</para>
|
||||
<para role="shortdesc">Deletes a token.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="admin-listEndpointsForToken">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="List endoints for token">
|
||||
<para role="shortdesc">Lists the endpoints associated with a specified token.</para>
|
||||
<para role="shortdesc">Lists the endpoints associated with a token.</para>
|
||||
</wadl:doc>
|
||||
<!-- <request>
|
||||
&limitMarkerReqParameter;
|
||||
@ -755,7 +753,7 @@
|
||||
Lists all users.
|
||||
</para>
|
||||
<para>
|
||||
To get detailed information about a specified user by user
|
||||
To get detailed information about a user by user
|
||||
name, include the <code>name</code> query parameter in the
|
||||
request.
|
||||
</para>
|
||||
@ -780,7 +778,7 @@
|
||||
<method name="GET" id="admin-getUserById">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get user information by ID">
|
||||
<para role="shortdesc">Gets detailed information about a specified user by user
|
||||
<para role="shortdesc">Gets detailed information about a user by user
|
||||
ID.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -792,7 +790,7 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="admin-listUserGlobalRoles">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List user global roles">
|
||||
<para role="shortdesc">Lists global roles for a specified user. Excludes tenant
|
||||
<para role="shortdesc">Lists global roles for a user. Excludes tenant
|
||||
roles.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -834,7 +832,7 @@
|
||||
<method name="GET" id="admin-getTenantByName">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get tenant information by name">
|
||||
<para role="shortdesc">Gets detailed information about a specified tenant by
|
||||
<para role="shortdesc">Gets detailed information about a tenant by
|
||||
name.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -858,7 +856,7 @@
|
||||
<method name="GET" id="admin-getTenantById">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Get tenant information by ID">
|
||||
<para role="shortdesc">Gets detailed information about a specified tenant by ID.</para>
|
||||
<para role="shortdesc">Gets detailed information about a tenant by ID.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
<representation mediaType="application/json" element="identity:tenant">
|
||||
@ -871,7 +869,7 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="admin-listRolesForUserOnTenant">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List roles for user">
|
||||
<para role="shortdesc">Lists roles for a specified user on a specified tenant. Excludes
|
||||
<para role="shortdesc">Lists roles for a user on a tenant. Excludes
|
||||
global roles.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -129,7 +129,7 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="getExtension-v2.0">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook" title="Get extension details">
|
||||
<para role="shortdesc">Gets detailed information for a specified extension.</para>
|
||||
<para role="shortdesc">Gets detailed information for a extension.</para>
|
||||
<para>Specify the extension alias in the URI.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -165,7 +165,7 @@
|
||||
HTTP <code>401</code> status code.
|
||||
</para>
|
||||
<para>
|
||||
If the token specified in the request has expired, this call
|
||||
If the token has expired, this call
|
||||
returns the HTTP <code>404</code> status code.
|
||||
</para>
|
||||
<para>
|
||||
@ -197,18 +197,25 @@
|
||||
</xsdxt:sample>
|
||||
</wadl:doc>
|
||||
<param name="tenantName" style="plain" required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The tenant name. Both the
|
||||
<code>tenantId</code> and <code>tenantName</code> attributes are
|
||||
optional, but should not be specified together. If both attributes are
|
||||
specified, the server responds with a <code>400</code>
|
||||
<code>Bad Request</code>.</para></wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook">
|
||||
<para>
|
||||
The tenant name. Both the <code>tenantId</code>
|
||||
and <code>tenantName</code> attributes are
|
||||
optional and mutually exclusive. If you specify
|
||||
both attributes, the server returns the <code>Bad
|
||||
Request (400)</code> response code.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="tenantId" style="plain" required="false" type="capi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>The tenant ID. Both the
|
||||
<code>tenantId</code> and <code>tenantName</code> attributes are
|
||||
optional, but should not be specified together. If both attributes are
|
||||
specified, the server responds with a <code>400</code>
|
||||
<code>Bad Request</code>.</para></wadl:doc>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook">
|
||||
<para>
|
||||
The tenant ID. Both the <code>tenantId</code>
|
||||
and <code>tenantName</code> attributes are
|
||||
optional and mutually exclusive. If you specify
|
||||
both attributes, the server returns the <code>Bad
|
||||
Request (400)</code> response code.
|
||||
</para></wadl:doc>
|
||||
</param>
|
||||
<param name="passwordCredentials" style="plain" required="false" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"><para>A
|
||||
@ -360,7 +367,7 @@
|
||||
<!-- Tenant Operations -->
|
||||
<method name="GET" id="listTenants">
|
||||
<wadl:doc title="List tenants" xml:lang="EN" xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists tenants to which the specified token has access.</para>
|
||||
<para role="shortdesc">Lists tenants to which the token has access.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json" element="identity:tenants">
|
||||
|
@ -47,7 +47,7 @@
|
||||
xml:lang="EN"><para>Filters on group ID.
|
||||
Specify <code>group.id={group_id}</code>
|
||||
to list all role assignments for the
|
||||
specified group.</para></wadl:doc>
|
||||
group.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="role.id" style="query" type="xsd:string"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -57,7 +57,7 @@
|
||||
xml:lang="EN"><para>Filters on role ID.
|
||||
Specify <code>role.id={role_id}</code> to
|
||||
list all role assignments for the
|
||||
specified role.</para></wadl:doc>
|
||||
role.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="scope.domain.id" style="query"
|
||||
type="xsd:string"
|
||||
@ -69,7 +69,7 @@
|
||||
Specify
|
||||
<code>scope.domain.id={domain_id}</code>
|
||||
to list all role assignments for the
|
||||
specified domain.</para></wadl:doc>
|
||||
domain.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="scope.project.id" style="query"
|
||||
type="xsd:string"
|
||||
@ -81,7 +81,7 @@
|
||||
Specify
|
||||
<code>scope.project.id={project_id}</code>
|
||||
to list all role assignments for the
|
||||
specified project.</para></wadl:doc>
|
||||
project.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="user.id" style="query" type="xsd:string"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -91,7 +91,7 @@
|
||||
xml:lang="EN"><para>Filters on user ID.
|
||||
Specify <code>user.id={user_id}</code> to
|
||||
list all role assignments for the
|
||||
specified user.</para></wadl:doc>
|
||||
user.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="effective" style="query" type="xsd:key"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -274,7 +274,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Assign role to user">
|
||||
<para role="shortdesc">
|
||||
Assigns a specified role to a specified user on projects in a subtree.
|
||||
Assigns a role to a user on projects in a subtree.
|
||||
</para>
|
||||
<para>
|
||||
The inherited role assignment is anchored to a project and
|
||||
@ -292,8 +292,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Check role for user">
|
||||
<para role="shortdesc">
|
||||
Checks whether a specified user has a specified role assignment with the
|
||||
<code>inherited_to_projects</code> flag on a specified
|
||||
Checks whether a user has a role assignment with the
|
||||
<code>inherited_to_projects</code> flag on a
|
||||
project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -303,7 +303,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Revoke role from user">
|
||||
<para role="shortdesc">
|
||||
Revokes an inherited role from a specified user a specified
|
||||
Revokes an inherited role from a user on a
|
||||
project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -313,12 +313,11 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List roles for user">
|
||||
<para role="shortdesc">
|
||||
Lists the inherited project roles for a specified user on a
|
||||
specified project.
|
||||
Lists the inherited project roles for a user on a
|
||||
project.
|
||||
</para>
|
||||
<para>
|
||||
The list contains only those roles that are assigned to this
|
||||
project that were specified as being inherited to its subtree.
|
||||
The list shows only roles inherited from the parent project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -337,7 +336,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Assign role to group">
|
||||
<para role="shortdesc">
|
||||
Assigns a specified role to a specified group on projects in a subtree.
|
||||
Assigns a role to a group on projects in a subtree.
|
||||
</para>
|
||||
<para>
|
||||
The inherited role assignment is anchored to a project and
|
||||
@ -355,8 +354,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Check role for group">
|
||||
<para role="shortdesc">
|
||||
Checks whether a specified group has a specified role assignment with the
|
||||
<code>inherited_to_projects</code> flag on a specified
|
||||
Checks whether a group has a role assignment with the
|
||||
<code>inherited_to_projects</code> flag on a
|
||||
project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -366,8 +365,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Revoke role from group">
|
||||
<para role="shortdesc">
|
||||
Revokes an inherited role from a specified group on a
|
||||
specified project.
|
||||
Revokes an inherited role from a group on a
|
||||
project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -376,12 +375,11 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List roles for group">
|
||||
<para role="shortdesc">
|
||||
Lists the inherited project roles for a specified group on a
|
||||
specified project.
|
||||
Lists the inherited project roles for a group on a
|
||||
project.
|
||||
</para>
|
||||
<para>
|
||||
The list contains only those roles that are assigned to this
|
||||
project that were specified as being inherited to its subtree.
|
||||
The list shows only roles inherited from the parent project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -401,8 +399,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Assign role to user owned by domain projects">
|
||||
<para role="shortdesc">
|
||||
Assigns a specified role to a specified user on projects owned by a
|
||||
specified domain.
|
||||
Assigns a role to a user on projects owned by a
|
||||
domain.
|
||||
</para>
|
||||
<para>
|
||||
The inherited role is applied to only the owned projects, both
|
||||
@ -416,8 +414,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Check project role for user on domain">
|
||||
<para role="shortdesc">
|
||||
Checks whether a specified user has an inherited project role
|
||||
on a specified domain.
|
||||
Checks whether a user has an inherited project role
|
||||
on a domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
@ -426,8 +424,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Revoke project role from user on domain">
|
||||
<para role="shortdesc">
|
||||
Revokes an inherited project role from a specified user on a
|
||||
specified domain.
|
||||
Revokes an inherited project role from a user on a
|
||||
domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -436,13 +434,11 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List project roles for user on domain">
|
||||
<para role="shortdesc">
|
||||
Lists the inherited project roles on a specified domain for a
|
||||
specified user.
|
||||
Lists the inherited project roles on a domain for a
|
||||
user.
|
||||
</para>
|
||||
<para>
|
||||
The list contains only those role assignments to the domain
|
||||
that were specified as being inherited to projects within that
|
||||
domain.
|
||||
The list shows only roles inherited from the parent project within the domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -461,8 +457,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Assign role to group on domain projects">
|
||||
<para role="shortdesc">
|
||||
Assigns a specified role to a specified group on projects owned by a
|
||||
specified domain.
|
||||
Assigns a role to a group on projects owned by a
|
||||
domain.
|
||||
</para>
|
||||
<para>
|
||||
The inherited role is applied to only the owned projects, both
|
||||
@ -476,8 +472,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Check project role for group on domain">
|
||||
<para role="shortdesc">
|
||||
Checks whether a specified group has an inherited project role
|
||||
on a specified domain.
|
||||
Checks whether a group has an inherited project role
|
||||
on a domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
@ -486,8 +482,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Revoke project role from group on domain">
|
||||
<para role="shortdesc">
|
||||
Revokes an inherited project role from a specified group on a
|
||||
specified domain.
|
||||
Revokes an inherited project role from a group on a
|
||||
domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -496,12 +492,11 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List project roles for group on domain">
|
||||
<para role="shortdesc">
|
||||
Lists the inherited project roles on a specified domain for a
|
||||
specified group.
|
||||
Lists the inherited project roles on a domain for a
|
||||
group.
|
||||
</para>
|
||||
<para>
|
||||
The list contains only those role assignments to the domain
|
||||
that were specified as being inherited to projects within that
|
||||
The list shows only roles inherited from the parent project within the
|
||||
domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -530,11 +525,11 @@
|
||||
filter the list, use the query parameters.</para>
|
||||
<para>Some typical examples are:</para>
|
||||
<para><code>GET /role_assignments?user.id={user_id}</code>
|
||||
lists all role assignments for the specified
|
||||
lists all role assignments for a
|
||||
user.</para>
|
||||
<para><code>GET
|
||||
/role_assignments?scope.project.id={project_id}</code>
|
||||
lists all role assignments for the specified
|
||||
lists all role assignments for a
|
||||
project.</para>
|
||||
<para>Each role assignment entity in the collection
|
||||
contains a link to the assignment that created this
|
||||
@ -575,8 +570,7 @@
|
||||
or parent project.
|
||||
</para>
|
||||
<para>
|
||||
An example response for an API call with the query string
|
||||
effective specified follows:
|
||||
An example response for an API call with the <code>effective</code> query string:
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
|
@ -429,8 +429,8 @@
|
||||
</response> &commonFaults; &getFaults; </method>
|
||||
<method name="GET" id="showConsumer">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show consumer">
|
||||
<para role="shortdesc">Shows information for a specified
|
||||
title="Show consumer details">
|
||||
<para role="shortdesc">Shows details for a
|
||||
consumer.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -469,7 +469,7 @@
|
||||
<method name="DELETE" id="deleteConsumer">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete consumer">
|
||||
<para role="shortdesc">Deletes a specified
|
||||
<para role="shortdesc">Deletes a
|
||||
consumer.</para>
|
||||
<para>When you delete a consumer, any associated request
|
||||
tokens, access tokens, and Identity API tokens
|
||||
@ -480,7 +480,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update consumer">
|
||||
<para role="shortdesc">Updates the description for a
|
||||
specified consumer.</para>
|
||||
consumer.</para>
|
||||
<para>If you try to update any attribute other than
|
||||
description, the HTTP 400 Bad Request error is
|
||||
returned.</para>
|
||||
@ -805,17 +805,17 @@
|
||||
<method name="GET" id="listRolesOfAccessToken">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List roles for an access token">
|
||||
<para role="shortdesc">Lists associated roles for a
|
||||
specified access token.
|
||||
<para role="shortdesc">Lists associated roles for an
|
||||
access token.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200"/>
|
||||
&commonFaults; </method>
|
||||
<method name="GET" id="getRoleOfAccessToken">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get role information for an access token">
|
||||
<para role="shortdesc">Gets information about a specified
|
||||
role for a specified access token.</para>
|
||||
title="Show role details for an access token">
|
||||
<para role="shortdesc">Shows details for a
|
||||
role for an access token.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<param name="id" style="plain" type="csapi:uuid"
|
||||
|
@ -1318,7 +1318,7 @@ xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the results by the specified parent region, by ID.
|
||||
Filters the results by a parent region, by ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -1329,9 +1329,3 @@ xmlns="http://wadl.dev.java.net/2009/02">
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"><para>The
|
||||
links for the regions resource.</para></wadl:doc>
|
||||
</param>'>
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY PATCH '<command xmlns="http://docbook.org/ns/docbook">PATCH</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
|
@ -349,7 +349,7 @@
|
||||
xml:lang="EN"><para>Filters on group ID.
|
||||
Specify <code>group.id={group_id}</code>
|
||||
to list all role assignments for the
|
||||
specified group.</para></wadl:doc>
|
||||
group.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="role.id" style="query" type="xsd:string"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -359,7 +359,7 @@
|
||||
xml:lang="EN"><para>Filters on role ID.
|
||||
Specify <code>role.id={role_id}</code> to
|
||||
list all role assignments for the
|
||||
specified role.</para></wadl:doc>
|
||||
role.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="scope.domain.id" style="query"
|
||||
type="xsd:string"
|
||||
@ -371,7 +371,7 @@
|
||||
Specify
|
||||
<code>scope.domain.id={domain_id}</code>
|
||||
to list all role assignments for the
|
||||
specified domain.</para></wadl:doc>
|
||||
domain.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="scope.project.id" style="query"
|
||||
type="xsd:string"
|
||||
@ -383,7 +383,7 @@
|
||||
Specify
|
||||
<code>scope.project.id={project_id}</code>
|
||||
to list all role assignments for the
|
||||
specified project.</para></wadl:doc>
|
||||
project.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="user.id" style="query" type="xsd:string"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -393,7 +393,7 @@
|
||||
xml:lang="EN"><para>Filters on user ID.
|
||||
Specify <code>user.id={user_id}</code> to
|
||||
list all role assignments for the
|
||||
specified user.</para></wadl:doc>
|
||||
user.</para></wadl:doc>
|
||||
</param>
|
||||
<param name="effective" style="query" type="xsd:key"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
@ -741,7 +741,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Validate token">
|
||||
<para role="shortdesc">
|
||||
Validates a specified token.
|
||||
Validates a token.
|
||||
</para>
|
||||
<para>
|
||||
Pass your own token in the <code>X-Auth-Token</code> header.
|
||||
@ -785,7 +785,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Check token">
|
||||
<para role="shortdesc">
|
||||
Validates a specified token.
|
||||
Validates a token.
|
||||
</para>
|
||||
<para>
|
||||
This call is similar to <code>GET /auth/tokens</code> but no
|
||||
@ -821,7 +821,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Revoke token">
|
||||
<para role="shortdesc">
|
||||
Revokes a specified token.
|
||||
Revokes a token.
|
||||
</para>
|
||||
<para>
|
||||
This call is similar to <code>HEAD /auth/tokens</code> except
|
||||
@ -953,7 +953,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show service details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified service.
|
||||
Shows details for a service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -979,7 +979,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update service">
|
||||
<para role="shortdesc">
|
||||
Updates a specified service.
|
||||
Updates a service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1011,7 +1011,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete service">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified service.
|
||||
Deletes a service.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
@ -1102,7 +1102,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update endpoint">
|
||||
<para role="shortdesc">
|
||||
Updates a specified endpoint.
|
||||
Updates a endpoint.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1139,7 +1139,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete endpoint">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified endpoint.
|
||||
Deletes a endpoint.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1213,7 +1213,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show domain details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified domain.
|
||||
Shows details for a domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1235,7 +1235,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update domain">
|
||||
<para role="shortdesc">
|
||||
Updates a specified domain.
|
||||
Updates a domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1269,7 +1269,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete domain">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified domain.
|
||||
Deletes a domain.
|
||||
</para>
|
||||
<para>
|
||||
To minimize the risk of accidentally deleting a domain, you
|
||||
@ -1313,7 +1313,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Grant role to domain user">
|
||||
<para role="shortdesc">
|
||||
Grants a role to a specified domain user.
|
||||
Grants a role to a domain user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1323,7 +1323,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Check role for domain user">
|
||||
<para role="shortdesc">
|
||||
Validates that a specified user has a specified role on a
|
||||
Validates that a user has a role on a
|
||||
domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1334,7 +1334,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Revoke role from domain user">
|
||||
<para role="shortdesc">
|
||||
Revokes a role from a specified domain user.
|
||||
Revokes a role from a domain user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1344,7 +1344,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List roles for domain group">
|
||||
<para role="shortdesc">
|
||||
Lists roles for a specified domain group.
|
||||
Lists roles for a domain group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1364,8 +1364,8 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Grant role to domain group">
|
||||
<para role="shortdesc">Grants a specified role to a
|
||||
specified domain group.</para>
|
||||
<para role="shortdesc">Grants a role to a
|
||||
domain group.</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
<response status="204"/> &commonFaults; &getFaults; </method>
|
||||
@ -1374,7 +1374,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Check role for domain group">
|
||||
<para role="shortdesc">
|
||||
Validates that a specified group has a specified role on a
|
||||
Validates that a group has a role on a
|
||||
domain.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1455,7 +1455,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show project details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified project.
|
||||
Shows details for a project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
|
||||
@ -1477,7 +1477,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update project">
|
||||
<para role="shortdesc">
|
||||
Updates a specified project.
|
||||
Updates a project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -1509,7 +1509,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete project">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified project.
|
||||
Deletes a project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is accepted -->
|
||||
@ -1519,7 +1519,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List roles for project user">
|
||||
<para role="shortdesc">
|
||||
Lists roles for a specified user in a project.
|
||||
Lists roles for a user in a project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1540,7 +1540,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Grant role to project user">
|
||||
<para role="shortdesc">
|
||||
Grants a role to a specified user in a
|
||||
Grants a role to a user in a
|
||||
project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1551,8 +1551,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Check role for project user">
|
||||
<para role="shortdesc">
|
||||
Validates that a specified user has a
|
||||
specified role in a project.
|
||||
Validates that a user has a
|
||||
role in a project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1562,7 +1562,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Revoke role from project user">
|
||||
<para role="shortdesc">
|
||||
Revokes a role from a specified project
|
||||
Revokes a role from a project
|
||||
user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1573,7 +1573,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List roles for project group">
|
||||
<para role="shortdesc">
|
||||
Lists roles for a specified project
|
||||
Lists roles for a project
|
||||
group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1595,7 +1595,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Grant role to project group">
|
||||
<para role="shortdesc">
|
||||
Grants a specified role to a specified project
|
||||
Grants a role to a project
|
||||
group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1606,8 +1606,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Check role for project group">
|
||||
<para role="shortdesc">
|
||||
Validates that a specified project group has
|
||||
a specified role.
|
||||
Validates that a project group has
|
||||
a role.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1617,7 +1617,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Revoke role from project group">
|
||||
<para role="shortdesc">
|
||||
Revokes a specified role from a specified project
|
||||
Revokes a role from a project
|
||||
group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1687,7 +1687,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show user details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified
|
||||
Shows details for a
|
||||
user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1709,7 +1709,7 @@
|
||||
xml:lang="EN" title="Update user">
|
||||
<para role="shortdesc">
|
||||
Updates the password for or enables
|
||||
or disables a specified user.
|
||||
or disables a user.
|
||||
</para>
|
||||
<para>
|
||||
If the back-end driver does not allow this functionality, this
|
||||
@ -1745,7 +1745,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete user">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified user.
|
||||
Deletes a user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1755,7 +1755,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List projects for user">
|
||||
<para role="shortdesc">
|
||||
List projects for a specified user.
|
||||
List projects for a user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1776,7 +1776,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List groups for user">
|
||||
<para role="shortdesc">
|
||||
Lists groups for a specified user.
|
||||
Lists groups for a user.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1860,7 +1860,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show group details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified
|
||||
Shows details for a
|
||||
group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -1883,7 +1883,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update group">
|
||||
<para role="shortdesc">
|
||||
Updates a specified group.
|
||||
Updates a group.
|
||||
</para>
|
||||
<para>
|
||||
If the back-end driver does not allow this functionality, this
|
||||
@ -1920,7 +1920,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete group">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified group.
|
||||
Deletes a group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1930,8 +1930,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Assign user to group">
|
||||
<para role="shortdesc">
|
||||
Assigns a specified user to a specified
|
||||
group.
|
||||
Assigns a user to a group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1941,7 +1940,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Remove user from group">
|
||||
<para role="shortdesc">
|
||||
Removes a specified user from a specified group.
|
||||
Removes a user from a group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1951,8 +1950,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Check user membership in group">
|
||||
<para role="shortdesc">
|
||||
Validates that a specified user is in a specified
|
||||
group.
|
||||
Validates that a user is in a group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -1962,8 +1960,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List users in group">
|
||||
<para role="shortdesc">
|
||||
Lists the users in a specified
|
||||
group.
|
||||
Lists users in a group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -2059,7 +2056,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show credential details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified credential.
|
||||
Shows details for a credential.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -2080,7 +2077,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update credential">
|
||||
<para role="shortdesc">
|
||||
Updates a specified credential.
|
||||
Updates a credential.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -2112,7 +2109,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete credential">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified credential.
|
||||
Deletes a credential.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -2186,7 +2183,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show role details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified
|
||||
Shows details for a
|
||||
role.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -2207,7 +2204,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update role">
|
||||
<para role="shortdesc">
|
||||
Updates a specified role.
|
||||
Updates a role.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -2242,7 +2239,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete role">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified role.
|
||||
Deletes a role.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -2263,12 +2260,12 @@
|
||||
</para>
|
||||
<para>
|
||||
<code>GET /role_assignments?user.id={user_id}</code> lists
|
||||
role assignments for the specified user.
|
||||
role assignments for a user.
|
||||
</para>
|
||||
<para>
|
||||
<code>GET
|
||||
/role_assignments?scope.project.id={project_id}</code>
|
||||
lists role assignments for the specified project.
|
||||
lists role assignments for a project.
|
||||
</para>
|
||||
<para>
|
||||
Each role assignment entity in the collection contains a link
|
||||
@ -2404,7 +2401,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show policy details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified
|
||||
Shows details for a
|
||||
policy.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -2427,7 +2424,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update policy">
|
||||
<para role="shortdesc">
|
||||
Updates a specified policy.
|
||||
Updates a policy.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -2461,7 +2458,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete policy">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified policy.
|
||||
Deletes a policy.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<!--No request body is provided-->
|
||||
@ -2603,7 +2600,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Show region details">
|
||||
<para role="shortdesc">
|
||||
Shows details for a specified region, by ID.
|
||||
Shows details for a region, by ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
@ -2623,7 +2620,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Update region">
|
||||
<para role="shortdesc">
|
||||
Updates a specified region.
|
||||
Updates a region.
|
||||
</para>
|
||||
<para>
|
||||
If you try to update a region with a parent region ID that
|
||||
@ -2664,7 +2661,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete region">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified region.
|
||||
Deletes a region.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
|
@ -62,7 +62,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list by a specified image name,
|
||||
Filters the image list by a image name,
|
||||
in string format.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -74,7 +74,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list by a specified container
|
||||
Filters the image list by a container
|
||||
format, such as <code>ovf</code>,
|
||||
<code>bare</code>, <code>aki</code>,
|
||||
<code>ari</code>, or <code>ami</code>.
|
||||
@ -88,7 +88,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list by a specified disk format. A valid value
|
||||
Filters the image list by a disk format. A valid value
|
||||
is <code>aki</code>, <code>ari</code>, <code>ami</code>,
|
||||
<code>raw</code>, <code>iso</code>, <code>vhd</code>,
|
||||
<code>vdi</code>, <code>qcow2</code>, or <code>vmdk</code>.
|
||||
@ -102,7 +102,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list by a specified status. A
|
||||
Filters the image list by a status. A
|
||||
valid value is <code>queued</code>,
|
||||
<code>saving</code>, <code>active</code>,
|
||||
<code>killed</code>, <code>deleted</code>, or
|
||||
@ -117,7 +117,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list by a specified minimum
|
||||
Filters the image list by a minimum
|
||||
image size, in bytes.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -129,7 +129,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list by a specified maximum
|
||||
Filters the image list by a maximum
|
||||
image size, in bytes.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -142,7 +142,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Filters the image list to those images that
|
||||
have changed since a specified time stamp
|
||||
have changed since a time stamp
|
||||
value.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -167,8 +167,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="can_share">
|
||||
<para>
|
||||
Indicates whether the specified owner is
|
||||
authorized to share the specified image.
|
||||
Indicates whether the owner is
|
||||
authorized to share the image.
|
||||
</para>
|
||||
<para>
|
||||
If the owner can share the image, this value is
|
||||
|
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
|
||||
<!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
@ -200,8 +200,8 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN"
|
||||
title="Get extension details">
|
||||
<para>Gets detailed information for a specified
|
||||
title="Show extension details">
|
||||
<para>Shows details for an
|
||||
extension.</para>
|
||||
</wadl:doc>
|
||||
<response status="200 203">
|
||||
@ -458,7 +458,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="Delete image">
|
||||
<para role="shortdesc">Deletes the specified image.</para>
|
||||
<para role="shortdesc">Deletes an image.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
@ -467,7 +467,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="List shared images">
|
||||
<para role="shortdesc">
|
||||
Lists the VM images that are shared with a specified owner.
|
||||
Lists the VM images that are shared with a owner.
|
||||
The owner ID is the tenant ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
|
@ -58,7 +58,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images with the specified name.
|
||||
Shows only images with this name.
|
||||
</para>
|
||||
<para>
|
||||
A valid value is the name of the image as a string.
|
||||
@ -73,7 +73,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images with the specified image visibility value or values.
|
||||
Shows only images with this image visibility value or values.
|
||||
</para>
|
||||
<para>
|
||||
Valid values are <code>public</code>, <code>private</code>, and
|
||||
@ -91,7 +91,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images with the specified member status.
|
||||
Shows only images with this member status.
|
||||
</para>
|
||||
<para>
|
||||
A valid value is <code>accepted</code>, <code>pending</code>,
|
||||
@ -108,7 +108,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images that are shared with the specified owner.
|
||||
Shows only images that are shared with this owner.
|
||||
</para>
|
||||
<para>A valid value is a tenant ID.
|
||||
</para>
|
||||
@ -122,7 +122,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images with the specified image status.
|
||||
Shows only images with this image status.
|
||||
</para>
|
||||
<para>
|
||||
A valid value is <code>queued</code>, <code>saving</code>,
|
||||
@ -139,7 +139,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images with the specified minimum image size.
|
||||
Shows only images with this minimum image size.
|
||||
</para>
|
||||
<para>
|
||||
A valid value is the minimum size of the image,
|
||||
@ -154,9 +154,9 @@
|
||||
<para>Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only images with the specified maximum image size.
|
||||
Shows only images with this maximum image size.
|
||||
</para>
|
||||
<para>A valid valud is the maximum size of the image,
|
||||
<para>A valid value is the maximum size of the image,
|
||||
in bytes.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -514,13 +514,14 @@
|
||||
xml:lang="EN">
|
||||
<para>The operation. A valid value is:</para>
|
||||
<para><code>add</code>. Adds a property or location in the
|
||||
specified image.
|
||||
image.
|
||||
</para>
|
||||
<para><code>remove</code>. Removes the specified image's
|
||||
property or location.
|
||||
<para>
|
||||
<code>remove</code>. Removes an image's property or location.
|
||||
</para>
|
||||
<para><code>replace</code>. Replaces the value of a specified
|
||||
image's property or location.
|
||||
<para>
|
||||
<code>replace</code>. Replaces the value of an image's property or
|
||||
location.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -655,7 +656,7 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only namespaces with the specified visibility value or values.
|
||||
Shows only namespaces with this visibility value or values.
|
||||
</para>
|
||||
<para>
|
||||
Valid values are <code>public</code> and <code>private</code>. If you
|
||||
@ -672,14 +673,14 @@
|
||||
Filter parameter.
|
||||
</para>
|
||||
<para>
|
||||
Shows only namespaces with the specified resource type or
|
||||
Shows only namespaces with this resource type or
|
||||
types.
|
||||
</para>
|
||||
<para>
|
||||
Specify multiple values as a comma-separated list. For example, set the
|
||||
<code>resource_types</code> filter to
|
||||
<code>OS::Glance::Image,OS::Nova::Flavor</code> to include only
|
||||
namespaces that are associated with the specified resource types.
|
||||
namespaces that are associated with this resource types.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -803,10 +804,10 @@
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Specifies the prefix to use for the given resource type.
|
||||
Any properties in the namespace should be prefixed with this
|
||||
prefix when being applied to the specified resource type.
|
||||
Must include prefix separator (e.g. a colon :).
|
||||
<para>
|
||||
Specifies the prefix to use for the resource type. Prefix any properties
|
||||
that you want to apply to the resource type in the namespace with this
|
||||
prefix. Must include a prefix separator, such as the colon (:) character.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -1188,7 +1189,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Filters by a specified task type. A valid value is <code>import</code>.
|
||||
Filters by a task type. A valid value is <code>import</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -1197,7 +1198,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Filters by a specified task status. A valid value is
|
||||
Filters by a task status. A valid value is
|
||||
<code>pending</code>, <code>processing</code>, <code>success</code>, or
|
||||
<code>failure</code>.
|
||||
</para>
|
||||
|
@ -115,8 +115,8 @@
|
||||
<method name="GET" id="listImages-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List images">
|
||||
<para role="shortdesc">Lists public virtual machine (VM)
|
||||
images. (Since Image API v2.0.)
|
||||
<para role="shortdesc">(Since Image API v2.0) Lists public virtual machine (VM)
|
||||
images.
|
||||
</para>
|
||||
<para>
|
||||
Returns a subset of the larger collection of images and a link
|
||||
@ -170,7 +170,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>sort_dir</code>. Sorts in a specified sort direction.
|
||||
<code>sort_dir</code>. Sorts in a sort direction.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -221,8 +221,8 @@
|
||||
<method name="POST" id="createImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create image">
|
||||
<para role="shortdesc">Creates a virtual machine (VM)
|
||||
image. (Since Image API v2.0.)
|
||||
<para role="shortdesc">(Since Image API v2.0) Creates a virtual machine (VM)
|
||||
image.
|
||||
</para>
|
||||
<para>Created with a <code>Location</code> header that
|
||||
contains the newly-created URI for the image. Response
|
||||
@ -327,70 +327,100 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update image">
|
||||
<para role="shortdesc">
|
||||
Updates a specified image. (Since Image API v2.0.)
|
||||
(Since Image API v2.0) Updates a image.
|
||||
</para>
|
||||
<para>
|
||||
Depending on the referenced target location, this operation
|
||||
performs one of the following functions:
|
||||
performs one of these actions:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The target location is an array index. A new value is
|
||||
inserted into the array at the specified index.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The target location is an object member that does not
|
||||
exist. A new member is added to the object.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The target location is an object member that exists.
|
||||
The member value is replaced.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<table rules="all" frame="border">
|
||||
<caption>Image update actions</caption>
|
||||
<col width="30%"/>
|
||||
<col width="70%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Target location</th>
|
||||
<th>Update action</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<para>
|
||||
An array index
|
||||
</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
A new value is inserted into the array at the index.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>
|
||||
An object member that does not exist
|
||||
</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
A new member is added to the object.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>
|
||||
An object member that exists
|
||||
</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
The member value is replaced.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para>
|
||||
The operation object MUST contain a <code>value</code> member that
|
||||
specifies the value to add. For example:
|
||||
The operation object must contain a <code>value</code> member that
|
||||
contains the value to add. For example:
|
||||
</para>
|
||||
<programlisting language="json">{
|
||||
"op": "add",
|
||||
"path": "/a/b/c",
|
||||
"value": [
|
||||
"foo",
|
||||
"bar"
|
||||
]
|
||||
"op": "add",
|
||||
"path": "/a/b/c",
|
||||
"value": [
|
||||
"foo",
|
||||
"bar"
|
||||
]
|
||||
}</programlisting>
|
||||
<para>
|
||||
The target location MUST reference one of these values:
|
||||
The target location must reference one of these values:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The root of the target document. The specified value is the
|
||||
The root of the target document. The value is the
|
||||
entire content of the target document.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
A member to add to an object. The specified value is added
|
||||
to that object at the specified location. If the member
|
||||
already exists, it is replaced by the specified value.
|
||||
A member to add to an object. The value is added to that
|
||||
object at that location. If the member already exists, it is
|
||||
replaced by the value.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
An element to add to the array. The specified value is added
|
||||
to the array at the specified location. Any element that is
|
||||
at or above the specified index is shifted one position to
|
||||
the right. The specified index MUST NOT be greater than the
|
||||
number of elements in the array. If the hyphen (-) character
|
||||
is used to index the end of the array (see [RFC6901]), the
|
||||
value is appended to the array.
|
||||
An element to add to the array. The value is added to the
|
||||
array at the location. Any element that is at or above the
|
||||
index is shifted one position to the right. The index must
|
||||
not be greater than the number of elements in the array. If
|
||||
you use the hyphen (-) character to index the end of the
|
||||
array, the value is appended to the array. See <link
|
||||
xlink:href="http://tools.ietf.org/html/rfc6901">JavaScript
|
||||
Object Notation (JSON) Pointer</link>.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -407,7 +437,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code>application/openstack-images-v2.1-json-patch</code>
|
||||
(Since Image API v2.2.)
|
||||
(since Image API v2.2)
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -425,14 +455,14 @@
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
When you add or replace a location to the specified image,
|
||||
When you add a location to or replace a location in the image,
|
||||
you must set the <code>disk_format</code> and
|
||||
<code>container_format</code> parameters in the image.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
When you replace a location, a location must be previously
|
||||
When you replace a location, that location must be previously
|
||||
set in the image.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -505,14 +535,13 @@
|
||||
<method name="GET" id="getImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get image details">
|
||||
<para role="shortdesc">Gets details for a specified image.
|
||||
(Since Image API v2.0.)
|
||||
<para role="shortdesc">(Since Image API v2.0) Gets details for a image.
|
||||
</para>
|
||||
<para>Response body is a single image entity.</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified image must exist.</para>
|
||||
<para>The image must exist.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -540,8 +569,7 @@
|
||||
<method name="POST" id="reactivateImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Reactivate image">
|
||||
<para role="shortdesc">Reactivates a specified image.
|
||||
(Since Image API v2.0.)
|
||||
<para role="shortdesc">(Since Image API v2.0) Reactivates a image.
|
||||
</para>
|
||||
<para>
|
||||
The reactivate operation returns an error if the image status is
|
||||
@ -550,7 +578,7 @@
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified image must exist.</para>
|
||||
<para>The image must exist.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -567,8 +595,7 @@
|
||||
<method name="POST" id="deactivateImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Deactivate image">
|
||||
<para role="shortdesc">Deactivates a specified image.
|
||||
(Since Image API v2.0.)
|
||||
<para role="shortdesc">(Since Image API v2.0) Deactivates a image.
|
||||
</para>
|
||||
<para>
|
||||
If you try to download a deactivated image, the 403 Forbidden
|
||||
@ -582,7 +609,7 @@
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified image must exist.</para>
|
||||
<para>The image must exist.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
@ -599,8 +626,8 @@
|
||||
<method name="DELETE" id="deleteImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete image">
|
||||
<para role="shortdesc">Deletes a specified image. (Since
|
||||
Image API v2.0.)
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.0) Deletes a image.
|
||||
</para>
|
||||
<para>You cannot delete images with the 'protected'
|
||||
attribute set to true (boolean).
|
||||
@ -657,18 +684,16 @@
|
||||
<method name="PUT" id="storeImageFile-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Upload binary image data">
|
||||
<para role="shortdesc">Uploads binary image data. (Since
|
||||
Image API v2.0.)
|
||||
<para role="shortdesc">(Since
|
||||
Image API v2.0) Uploads binary image data.
|
||||
</para>
|
||||
<para>Set the <code>Content-Type</code> request header to
|
||||
<code>application/octet-stream</code>.
|
||||
</para>
|
||||
<para>Example call: <code>curl -i -X PUT -H "X-Auth-Token:
|
||||
$token" -H "Content-Type:
|
||||
application/octet-stream" -d
|
||||
@/home/glance/ubuntu-12.10.qcow2
|
||||
$image_url/v2/images/{image_id}/file</code>
|
||||
<para>Example call:
|
||||
</para>
|
||||
<programlisting>curl -i -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" \
|
||||
-d @/home/glance/ubuntu-12.10.qcow2 $image_url/v2/images/{image_id}/file</programlisting>
|
||||
<para>Preconditions</para>
|
||||
<para>
|
||||
Before you can store binary image data, you must meet the
|
||||
@ -677,7 +702,7 @@
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The specified image must exist.
|
||||
The image must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -737,8 +762,8 @@
|
||||
<method name="GET" id="getImageFile-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Download binary image data">
|
||||
<para role="shortdesc">Downloads binary image data. (Since
|
||||
Image API v2.0.)
|
||||
<para role="shortdesc">(Since
|
||||
Image API v2.0) Downloads binary image data.
|
||||
</para>
|
||||
<para>Example call: <code>curl -i -X GET -H "X-Auth-Token:
|
||||
$token"
|
||||
@ -756,14 +781,14 @@
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified images must exist.</para>
|
||||
<para>The images must exist.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>You can download the binary image data
|
||||
in your machine if the specified image has image
|
||||
in your machine if the image has image
|
||||
data.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -792,7 +817,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Add image tag">
|
||||
<para role="shortdesc">
|
||||
Adds a specified tag to a specified image. (Since Image API v2.0.)
|
||||
(Since Image API v2.0) Adds a tag to a image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -801,8 +826,8 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete image tag">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified tag from a specified image. (Since Image API
|
||||
v2.0.)
|
||||
(Since Image API
|
||||
v2.0) Deletes a tag from a image.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/>
|
||||
@ -811,19 +836,18 @@
|
||||
<method name="GET" id="getImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" title="Show image member details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Shows image member details.</para>
|
||||
<para role="shortdesc">(Since Image API v2.2) Shows image member details.</para>
|
||||
<para>Response body is a single image member entity.
|
||||
(Since Image API v2.2.)
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified image must exist.
|
||||
<para>The image must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must be the owner or a member of
|
||||
the specified image.
|
||||
the image.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -843,8 +867,8 @@
|
||||
<method name="GET" id="listImageMembers-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List image members">
|
||||
<para role="shortdesc">Lists the tenants with whom this
|
||||
image has been shared. (Since Image API v2.1.)
|
||||
<para role="shortdesc">(Since Image API v2.1) Lists the tenants with whom this
|
||||
image has been shared.
|
||||
</para>
|
||||
<para>If a user with whom this image is shared makes this
|
||||
call, the member list contains only information for
|
||||
@ -857,12 +881,12 @@
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified image must exist.
|
||||
<para>The image must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must be the owner or a member of
|
||||
the specified image.
|
||||
the image.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -894,13 +918,13 @@
|
||||
<method name="POST" id="createImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create image member">
|
||||
<para role="shortdesc">Adds a specified tenant ID as an
|
||||
image member. (Since Image API v2.1.)
|
||||
<para role="shortdesc">(Since Image API v2.1) Adds a tenant ID as an
|
||||
image member.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified images must exist.
|
||||
<para>The images must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -909,7 +933,7 @@
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must be the owner of the specified
|
||||
<para>You must be the owner of the
|
||||
image.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -928,18 +952,19 @@
|
||||
<listitem>
|
||||
<para>
|
||||
Even if you have correct permissions, if the
|
||||
<code>visibility</code> attribute is set to <code>public</code>, the request
|
||||
returns the HTTP 403 error code. Ensure that you meet the preconditions
|
||||
and run the request again. If the request fails again,
|
||||
review your API request.
|
||||
<code>visibility</code> attribute is set to
|
||||
<code>public</code>, the request returns the HTTP 403
|
||||
response code. Ensure that you meet the preconditions and
|
||||
run the request again. If the request fails again, review
|
||||
your API request.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If the specified member is already a member for the image,
|
||||
the service returns the HTTP 409 Conflict error code. In
|
||||
case you meant a different member, double-check that you
|
||||
specified the correct member.
|
||||
If the member is already a member for the image, the service
|
||||
returns the <code>Conflict (409)</code> response code. If
|
||||
you meant to specify a different member, run the
|
||||
request again.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -979,19 +1004,18 @@
|
||||
<method name="PUT" id="updateImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update image member">
|
||||
<para role="shortdesc">Sets the specified status for the
|
||||
specified member of the specified image. (Since Image
|
||||
API v2.1.)
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.1) Sets the status for an image member.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified images must exist.
|
||||
<para>The images must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must be a member of the
|
||||
specified image.
|
||||
image.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -1047,18 +1071,18 @@
|
||||
<method name="DELETE" id="deleteImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete image member">
|
||||
<para role="shortdesc">Deletes a specified tenant ID from
|
||||
the member list of the specified image. (Since Image
|
||||
API v2.1.)
|
||||
<para role="shortdesc">
|
||||
(Since Image API v2.1) Deletes a tenant ID from the member list of
|
||||
an image.
|
||||
</para>
|
||||
<para>Preconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified image must exist.
|
||||
<para>The image must exist.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>You must be the owner of the specified
|
||||
<para>You must be the owner of the
|
||||
image.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1066,7 +1090,7 @@
|
||||
<para>Synchronous Postconditions</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified member is removed from
|
||||
<para>The member is removed from
|
||||
the image members.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1076,7 +1100,7 @@
|
||||
<listitem>
|
||||
<para>
|
||||
Even if you have correct permissions, if you are not the
|
||||
owner of the specified image, the request returns the HTTP
|
||||
owner of The image, the request returns the HTTP
|
||||
403 error code. Ensure that you meet the preconditions
|
||||
and run the request again. If the request fails again,
|
||||
review your API request.
|
||||
@ -1131,7 +1155,7 @@
|
||||
<method name="GET" id="showTasks-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show tasks">
|
||||
<para role="shortdesc">Shows details for a specified task.
|
||||
<para role="shortdesc">Shows details for a task.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -234,12 +234,10 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Filter parameter. Specify this value as comma-
|
||||
separated list. For example, send the
|
||||
<code>resource_types</code> filter of
|
||||
<code>OS::Glance::Image,OS::Nova::Flavor</code> to
|
||||
filter the namespaces by the specified resource
|
||||
types.
|
||||
Filter parameter. Specify this value as comma-separated list. For
|
||||
example, send the <code>resource_types</code> filter of
|
||||
<code>OS::Glance::Image,OS::Nova::Flavor</code> to filter the namespaces
|
||||
by those resource types.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -282,7 +280,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get namespaces details">
|
||||
<para role="shortdesc">
|
||||
Gets details for a specified namespace.
|
||||
Gets details for a namespace.
|
||||
</para>
|
||||
<para>
|
||||
The response body shows a single namespace entity with all
|
||||
@ -302,7 +300,7 @@
|
||||
<method name="PUT" id="updateNamespace-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update namespace">
|
||||
<para role="shortdesc">Updates a specified namespace.</para>
|
||||
<para role="shortdesc">Updates a namespace.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -327,7 +325,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete namespace">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified namespace and its properties,
|
||||
Deletes a namespace and its properties,
|
||||
objects, and any resource type associations.
|
||||
</para>
|
||||
<para>
|
||||
|
@ -66,7 +66,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create object">
|
||||
<para role="shortdesc">
|
||||
Creates an object definition in a specified
|
||||
Creates an object definition in a
|
||||
namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -218,7 +218,7 @@
|
||||
<method name="GET" id="getObject-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get object definition">
|
||||
<para role="shortdesc">Gets definition for a specified object.
|
||||
<para role="shortdesc">Gets definition for a object.
|
||||
</para>
|
||||
<para>Response body is a single object entity.</para>
|
||||
</wadl:doc>
|
||||
@ -236,7 +236,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update object definition">
|
||||
<para role="shortdesc">
|
||||
Updates a specified object definition in a specified
|
||||
Updates a object definition in a
|
||||
namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -263,7 +263,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete property definition">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified object definition within a namespace.
|
||||
Deletes a object definition within a namespace.
|
||||
</para>
|
||||
<para>
|
||||
You cannot delete objects in a namespace with the 'protected'
|
||||
|
@ -141,7 +141,7 @@
|
||||
<method name="GET" id="getProperty-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get property definition">
|
||||
<para role="shortdesc">Gets the definition for a specified property.
|
||||
<para role="shortdesc">Gets the definition for a property.
|
||||
</para>
|
||||
<para>
|
||||
If you include the <code>resource_type</code> query
|
||||
@ -165,7 +165,7 @@
|
||||
</para>
|
||||
<para>
|
||||
Shows only property names that start with a prefix
|
||||
from an associated specified resource type.
|
||||
from an associated resource type.
|
||||
</para>
|
||||
<para>
|
||||
The prefix of the included resource type is removed
|
||||
@ -199,7 +199,7 @@
|
||||
<method name="PUT" id="updateProperty-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update property definition">
|
||||
<para role="shortdesc">Updates a specified property definition.
|
||||
<para role="shortdesc">Updates a property definition.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -372,12 +372,12 @@
|
||||
If you use <i>tuple-typing</i>, describes extra
|
||||
items. If the value of <code>items</code> is an
|
||||
array and the instance is longer than the list of
|
||||
schemas in <code>items</code>, the schema in this
|
||||
schema in <code>items</code>, the schema in this
|
||||
property describes the additional items.
|
||||
</para>
|
||||
<para>
|
||||
If this value is false, the instance cannot be
|
||||
longer than the number of schemas listed in
|
||||
longer than the number of schemas that are listed in
|
||||
<code>items</code>.
|
||||
</para>
|
||||
<para>
|
||||
@ -413,7 +413,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Remove property definition">
|
||||
<para role="shortdesc">
|
||||
Removes a specified property definition in a specified
|
||||
Removes a property definition in a
|
||||
namespace.
|
||||
</para>
|
||||
<para>
|
||||
|
@ -104,12 +104,12 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Prefix for the specified resource type. If you
|
||||
specify a prefix, you must use this value followed
|
||||
by a prefix separator such as the colon
|
||||
(<code>:</code>) character to prefix any
|
||||
Prefix for the resource type. If you specify a
|
||||
prefix, you must use this value followed by a
|
||||
prefix separator, such as the colon
|
||||
(<code>:</code>) character, to prefix any
|
||||
properties in the namespace that you want to apply
|
||||
to the specified resource type.
|
||||
to the resource type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -165,7 +165,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List resource type associations">
|
||||
<para role="shortdesc">
|
||||
Lists resource type associations in a specified namespace.
|
||||
Lists resource type associations in a namespace.
|
||||
</para>
|
||||
<para>
|
||||
The response body lists resource type association entities.
|
||||
@ -185,7 +185,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Remove resource type association">
|
||||
<para role="shortdesc">
|
||||
Removes a specified resource type association in a specified
|
||||
Removes a resource type association in a
|
||||
namespace.
|
||||
</para>
|
||||
<para>
|
||||
|
@ -60,7 +60,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create tags">
|
||||
<para role="shortdesc">
|
||||
Creates one or more tag definitions in a specified namespace.
|
||||
Creates one or more tag definitions in a namespace.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -98,7 +98,7 @@
|
||||
<para>To sort the results of this operation use the
|
||||
<code>sort_key</code> and <code>sort_dir</code> parameters.
|
||||
The API uses the natural sort order of the tag attribute
|
||||
of the specified <code>sort_key</code> parameter.</para>
|
||||
of the <code>sort_key</code> parameter.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
@ -147,7 +147,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Add tag definition">
|
||||
<para role="shortdesc">
|
||||
Adds a specified tag to the list of namespace tag definitions.
|
||||
Adds a tag to the list of namespace tag definitions.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -169,8 +169,9 @@
|
||||
<method name="GET" id="getTag-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get tag definition">
|
||||
<para role="shortdesc">Gets a definition for the specified tag.
|
||||
</para>
|
||||
<para role="shortdesc">
|
||||
Gets a definition for a tag.
|
||||
</para>
|
||||
<para>The response body shows a single tag entity.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -193,7 +194,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update tag definition">
|
||||
<para role="shortdesc">
|
||||
Renames a specified tag definition.
|
||||
Renames a tag definition.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -221,7 +222,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete tag definition">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified tag definition within a namespace.
|
||||
Deletes a tag definition within a namespace.
|
||||
</para>
|
||||
<para>
|
||||
You cannot delete tags in a namespace with the 'protected'
|
||||
|
@ -488,7 +488,7 @@
|
||||
If you specify only a subnet UUID, OpenStack Networking
|
||||
allocates an available IP from that subnet to the port. If you
|
||||
specify both a subnet UUID and an IP address, OpenStack
|
||||
Networking tries to allocate the specified address to the port.
|
||||
Networking tries to allocate the address to the port.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -500,7 +500,7 @@
|
||||
If you specify only a subnet UUID, OpenStack Networking
|
||||
allocates an available IP from that subnet to the port. If you
|
||||
specify both a subnet UUID and an IP address, OpenStack
|
||||
Networking tries to allocate the specified address to the port.
|
||||
Networking tries to allocate the address to the port.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -510,7 +510,7 @@
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
If you specify both a subnet UUID and an IP address, OpenStack
|
||||
Networking tries to allocate the specified address to the port.
|
||||
Networking tries to allocate the address to the port.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -915,7 +915,7 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
A dictionary that enables the application running on the specified host
|
||||
A dictionary that enables the application running on the host
|
||||
to pass and receive virtual network interface (VIF) port-specific
|
||||
information to the plug-in.
|
||||
</para>
|
||||
@ -988,7 +988,7 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Read-only. The VIF type for the specified port.
|
||||
Read-only. The VIF type for the port.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -997,7 +997,7 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
A dictionary the enables the application running on the specified host
|
||||
A dictionary the enables the application running on the host
|
||||
to pass and receive VIF port-specific information to the plug-in.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -3111,7 +3111,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The tenant UUID for the specified metering label.
|
||||
The tenant UUID for the metering label.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -3259,7 +3259,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The UUID for the specified metering label rule.
|
||||
The UUID for the metering label rule.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -3323,7 +3323,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The UUID for the specified metering label rule.
|
||||
The UUID for the metering label rule.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -4602,7 +4602,7 @@
|
||||
The remote IP prefix to be associated with this security group rule.
|
||||
You can specify either the <code>remote_group_id</code> or
|
||||
<code>remote_ip_prefix</code> attribute in the request body. This
|
||||
attribute value matches the specified IP prefix as the source IP
|
||||
attribute value matches the IP prefix as the source IP
|
||||
address of the IP packet.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -4714,7 +4714,7 @@
|
||||
The remote IP prefix to be associated with this security group
|
||||
rule. You can specify either the <code>remote_group_id</code>
|
||||
or <code>remote_ip_prefix</code> attribute in the request body.
|
||||
This attribute matches the specified IP prefix as the source
|
||||
This attribute matches the IP prefix as the source
|
||||
IP address of the IP packet.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -5563,7 +5563,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
List of endpoints of the same type, for the endpoint group.
|
||||
The values will depend on type specified.
|
||||
The values will depend on type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -5662,7 +5662,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A list of endpoints of the same type for the endpoint group.
|
||||
Theses values depend on the specified type.
|
||||
Theses values depend on the type.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
@ -5803,8 +5803,8 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The UUID for the endpoint group that contains private subnets for the local
|
||||
side of the connection. Must be specified with the
|
||||
The UUID for the endpoint group that contains private subnets for the
|
||||
local side of the connection. Yo must specify this parameter with the
|
||||
<code>peer_ep_group_id</code> parameter unless in backward-compatible
|
||||
mode where <code>peer_cidrs</code> is provided with a
|
||||
<code>subnet_id</code> for the VPN service.
|
||||
@ -5819,7 +5819,7 @@
|
||||
<para>
|
||||
The UUID for the endpoint group that contains private CIDRs in the form
|
||||
<net_address>/<prefix> for the peer side of the connection.
|
||||
Must be specified with the <code>local_ep_group_id</code> parameter
|
||||
You must specify this parameter with the <code>local_ep_group_id</code> parameter
|
||||
unless in backward-compatible mode where <code>peer_cidrs</code> is
|
||||
provided with a <code>subnet_id</code> for the VPN service.
|
||||
</para>
|
||||
@ -6417,7 +6417,7 @@
|
||||
</para>
|
||||
<para>
|
||||
Each subnet prefix must be unique among all subnet prefixes in all
|
||||
subnet pools that are associated with the specified address scope.
|
||||
subnet pools that are associated with the address scope.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@ -6428,7 +6428,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The size of the prefix to allocate when the <code>cidr</code> or
|
||||
<code>prefixlen</code> attributes are not specified when you create
|
||||
<code>prefixlen</code> attributes are omitted when you create
|
||||
the subnet. Default is <code>min_prefixlen</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -6530,7 +6530,7 @@
|
||||
</para>
|
||||
<para>
|
||||
Ensure that each subnet prefix is unique among all subnet prefixes
|
||||
in all subnet pools that are associated with the specified address
|
||||
in all subnet pools that are associated with the address
|
||||
scope.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -6542,7 +6542,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The size of the prefix to allocate when the <code>cidr</code> or
|
||||
<code>prefixlen</code> attributes are not specified when you create
|
||||
<code>prefixlen</code> attributes are omitted when you create
|
||||
the subnet. Default is <code>min_prefixlen</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -6650,7 +6650,7 @@
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The size of the prefix to allocate when the <code>cidr</code> or
|
||||
<code>prefixlen</code> attributes are not specified when you create
|
||||
<code>prefixlen</code> attributes are omitted when you create
|
||||
the subnet.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
@ -6850,7 +6850,7 @@
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN" title="default">
|
||||
<para>
|
||||
Defines whether the provider is or is not the default for the specified
|
||||
Defines whether the provider is or is not the default for the
|
||||
service type. If this value is <code>true</code>, the provider is the
|
||||
default. If this value is <code>false</code>, the provider is not the
|
||||
default.
|
||||
|
@ -60,7 +60,7 @@
|
||||
<wadl:doc xml:lang="EN" title="List metering labels"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">
|
||||
Lists all l3 metering labels that belong to the specified
|
||||
Lists all l3 metering labels that belong to the
|
||||
tenant.
|
||||
</para>
|
||||
<para>
|
||||
@ -148,7 +148,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metering label">
|
||||
<para role="shortdesc">
|
||||
Shows information for a specified metering label.
|
||||
Shows information for a metering label.
|
||||
</para>
|
||||
<para>
|
||||
The response body shows the description, name, ID.
|
||||
@ -234,7 +234,7 @@
|
||||
title="List metering label rules">
|
||||
<para role="shortdesc">
|
||||
Lists a summary of all l3 metering label rules that belong to
|
||||
the specified tenant.
|
||||
the tenant.
|
||||
</para>
|
||||
<para>
|
||||
The list shows the unique ID for each metering label rule.
|
||||
@ -332,7 +332,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show metering label rule">
|
||||
<para role="shortdesc">
|
||||
Shows detailed information for a specified metering label
|
||||
Shows detailed information for a metering label
|
||||
rule.
|
||||
</para>
|
||||
<para>
|
||||
@ -353,7 +353,7 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The ID for the specified metering label rule.
|
||||
The ID for the metering label rule.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -406,7 +406,7 @@
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete metering label rule">
|
||||
<para role="shortdesc">
|
||||
Deletes a specified l3 metering label rule.
|
||||
Deletes a l3 metering label rule.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
|
@ -3,9 +3,9 @@
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
<!-- You can resolve the entites with xmllint -->
|
||||
<!-- You can resolve the entities with xmllint -->
|
||||
<!-- -->
|
||||
<!-- xmllint -noent os-fwaasv2.0-ext.wadl -->
|
||||
<!-- xmllint -noent os-fwaasv2.0-ext.wadl -->
|
||||
<!--*******************************************************-->
|
||||
<!DOCTYPE application [
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
@ -97,9 +97,9 @@
|
||||
<method name="GET" id="showFirewall">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show firewall details">
|
||||
<para role="shortdesc">Shows details for a specified firewall.</para>
|
||||
<para role="shortdesc">Shows details for a firewall.</para>
|
||||
<para>
|
||||
Shows the details for a specified firewall. If the user is not
|
||||
Shows the details for a firewall. If the user is not
|
||||
an administrative user and the firewall object does not belong
|
||||
to the user's tenant account, a 403 (Forbidden) error is
|
||||
returned.
|
||||
@ -144,9 +144,9 @@
|
||||
</method>
|
||||
<method name="PUT" id="updateFirewall">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update firewall">
|
||||
<para role="shortdesc">Updates a specified firewall.</para>
|
||||
<para role="shortdesc">Updates a firewall.</para>
|
||||
<para>
|
||||
Updates the attributes for a specified firewall. To update a
|
||||
Updates the attributes for a firewall. To update a
|
||||
service, the service status cannot be a <code>PENDING_*</code>
|
||||
status.
|
||||
</para>
|
||||
@ -173,7 +173,7 @@
|
||||
</method>
|
||||
<method name="DELETE" id="deleteFirewall">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove firewall">
|
||||
<para role="shortdesc">Removes a specified firewall.</para>
|
||||
<para role="shortdesc">Removes a firewall.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
@ -183,7 +183,7 @@ Accept: application/json</programlisting>
|
||||
<method name="GET" id="showRouter">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show router details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
router.</para>
|
||||
<para>This example request shows details for a router in
|
||||
JSON format:</para>
|
||||
@ -317,7 +317,7 @@ Accept: application/json</programlisting></wadl:doc>
|
||||
<listitem>
|
||||
<para>
|
||||
The ID of a port that is created by this operation to
|
||||
attach the specified subnet to the router.
|
||||
attach the subnet to the router.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -382,19 +382,20 @@ Accept: application/json</programlisting></wadl:doc>
|
||||
specify either a subnet ID or port ID in the request
|
||||
body; this value is used to identify the router
|
||||
interface to remove.</para>
|
||||
<para>You can also specify both a subnet ID and port ID.
|
||||
If you specify both IDs, the subnet ID must correspond
|
||||
to the subnet ID of the first IP address on the port
|
||||
specified by the port ID. Otherwise, the operation
|
||||
returns a <code>409 Conflict</code> error. The
|
||||
response contains information about the affected
|
||||
router and interface.</para>
|
||||
<para>The operation returns a <code>404 Not Found</code>
|
||||
if the router or the subnet and port do not exist or
|
||||
are not visible to you. As a consequence of this
|
||||
operation, the port connecting the router with the
|
||||
subnet is removed from the subnet for the
|
||||
network.</para>
|
||||
<para>
|
||||
You can specify both a subnet ID and port ID. If you specify
|
||||
both IDs, the subnet ID must correspond to the subnet ID of
|
||||
the first IP address on the port. Otherwise, the operation
|
||||
returns a <code>Conflict (409)</code> response code. The response
|
||||
contains information about the affected router and interface.
|
||||
</para>
|
||||
<para>
|
||||
The operation returns the <code>Not Found (404)</code>
|
||||
response code if the router or the subnet and port do not
|
||||
exist or are not visible to you. As a consequence of this
|
||||
operation, the port connecting the router with the subnet is
|
||||
removed from the subnet for the network.
|
||||
</para>
|
||||
<para>This example removes an interface from a
|
||||
router:</para>
|
||||
<programlisting>PUT /v2.0/routers/{router_id}/remove_router_interface
|
||||
@ -517,12 +518,12 @@ Accept: application/json</programlisting>
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The specified network is not external, such as
|
||||
<para>The network is not external, such as
|
||||
<code>router:external=False</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The specified internal OpenStack
|
||||
<para>The internal OpenStack
|
||||
Networking port is not associated with the floating IP
|
||||
address.
|
||||
</para>
|
||||
@ -535,7 +536,7 @@ Accept: application/json</programlisting>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The specified fixed IP address is not valid.
|
||||
The fixed IP address is not valid.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -545,7 +546,7 @@ Accept: application/json</programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><code>404</code> The specified port ID is not valid.
|
||||
<para><code>404</code> The port ID is not valid.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@ -561,9 +562,8 @@ Accept: application/json</programlisting>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The internal OpenStack Networking port and
|
||||
specified fixed IP address are already associated
|
||||
with another floating IP.
|
||||
The internal OpenStack Networking port and fixed IP
|
||||
address are already associated with another floating IP.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
@ -603,7 +603,7 @@ Accept: application/json</programlisting>
|
||||
<method name="GET" id="showFloatingIp">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show floating IP details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
floating IP.</para>
|
||||
<para>Use the <code>fields</code> query parameter to
|
||||
control which fields are returned in the response
|
||||
|
@ -156,7 +156,7 @@
|
||||
<method name="GET" id="showVIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show VIP details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
VIP.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"> &vipObject; &vipResponseParams; <representation
|
||||
@ -171,7 +171,7 @@
|
||||
<method name="PUT" id="updateVIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update VIP">
|
||||
<para role="shortdesc">Updates a specified load balancer
|
||||
<para role="shortdesc">Updates a load balancer
|
||||
VIP.</para>
|
||||
</wadl:doc>
|
||||
<request> &vipObject; &vipUpdateRequestParams; <representation
|
||||
@ -195,7 +195,7 @@
|
||||
<method name="DELETE" id="deleteVIP">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete VIP">
|
||||
<para role="shortdesc">Deletes a specified load balancer
|
||||
<para role="shortdesc">Deletes a load balancer
|
||||
VIP.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
@ -243,7 +243,7 @@
|
||||
<method name="GET" id="showPool">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show pool details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
pool.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"> &poolObject; &poolResponseParams; <representation
|
||||
@ -258,7 +258,7 @@
|
||||
<method name="PUT" id="updatePool">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update pool">
|
||||
<para role="shortdesc">Updates a specified load balancer
|
||||
<para role="shortdesc">Updates a load balancer
|
||||
pool.</para>
|
||||
</wadl:doc>
|
||||
<request> &poolObject; &poolUpdateRequestParams; <representation
|
||||
@ -283,7 +283,7 @@
|
||||
<method name="DELETE" id="deletePool">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete pool">
|
||||
<para role="shortdesc">Deletes a specified load balancer
|
||||
<para role="shortdesc">Deletes a load balancer
|
||||
pool.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
@ -331,7 +331,7 @@
|
||||
<method name="GET" id="showMember">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show member details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
member.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"> &memberObject; &memberResponseParams;
|
||||
@ -348,7 +348,7 @@
|
||||
<method name="PUT" id="updateMember">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update member">
|
||||
<para role="shortdesc">Updates a specified load balancer
|
||||
<para role="shortdesc">Updates a load balancer
|
||||
member.</para>
|
||||
</wadl:doc>
|
||||
<request> &memberObject; &memberUpdateRequestParams; <representation
|
||||
@ -375,7 +375,7 @@
|
||||
<method name="DELETE" id="deleteMember">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete member">
|
||||
<para role="shortdesc">Deletes a specified load balancer
|
||||
<para role="shortdesc">Deletes a load balancer
|
||||
member.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
@ -422,7 +422,7 @@
|
||||
<method name="GET" id="showHealthMonitor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show health monitor details">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
health monitor.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"> &hmObject; &hmResponseParams; <representation
|
||||
@ -438,7 +438,7 @@
|
||||
<method name="PUT" id="updateHealthMonitor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update health monitor">
|
||||
<para role="shortdesc">Updates a specified load balancer
|
||||
<para role="shortdesc">Updates a load balancer
|
||||
health monitor.</para>
|
||||
</wadl:doc>
|
||||
<request> &hmObject; &hmUpdateRequestParams; <representation
|
||||
@ -464,7 +464,7 @@
|
||||
<method name="DELETE" id="deleteHealthMonitor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Delete health monitor">
|
||||
<para role="shortdesc">Deletes a specified load balancer
|
||||
<para role="shortdesc">Deletes a load balancer
|
||||
health monitor.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
@ -474,7 +474,7 @@
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Associate health monitor with pool">
|
||||
<para role="shortdesc">Associates a health monitor with a
|
||||
specified pool.</para>
|
||||
pool.</para>
|
||||
</wadl:doc>
|
||||
<request> &hmObject; &hmassociatepoolRequestParams; <representation
|
||||
mediaType="application/json">
|
||||
@ -500,7 +500,7 @@
|
||||
<method name="DELETE" id="disassociateHealthMonitor">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Disassociate health monitor from pool">
|
||||
<para role="shortdesc">Disassociates a specified health
|
||||
<para role="shortdesc">Disassociates a health
|
||||
monitor from a pool.</para>
|
||||
</wadl:doc>
|
||||
<response status="204"/> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
|
@ -108,7 +108,7 @@
|
||||
<method name="GET" id="showLoadBalancerv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show load balancer details">
|
||||
<para role="shortdesc">Shows details for a specified load
|
||||
<para role="shortdesc">Shows details for a load
|
||||
balancer.</para>
|
||||
<para>
|
||||
This operation returns a load balancer object identified by
|
||||
@ -244,11 +244,11 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Some attributes receive default values if not specified in the request:</para>
|
||||
<para>Some attributes receive default values if you omit them from the request:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>admin_state_up</code>. The default is true.</para></listitem>
|
||||
<listitem><para><code>name</code>. The default is an empty string.</para></listitem>
|
||||
<listitem><para><code>description</code>. The default is an empty string.</para></listitem>
|
||||
<listitem><para><code>admin_state_up</code>. Default is <code>true</code>.</para></listitem>
|
||||
<listitem><para><code>name</code>. Default is an empty string.</para></listitem>
|
||||
<listitem><para><code>description</code>. Default is an empty string.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
If the request cannot be fulfilled due to insufficient data or
|
||||
@ -270,9 +270,9 @@
|
||||
<para>
|
||||
A user can supply a <code>vip_address</code> field if she owns
|
||||
the subnet on which the load balancer's VIP will be created.
|
||||
If a <code>vip_address</code> is not specified in the payload,
|
||||
the LBaaS service allocates one from the load balancer VIP's
|
||||
subnet.
|
||||
If a <code>vip_address</code> is omitted from the payload,
|
||||
the LBaaS service allocates a VIP address from the
|
||||
subnet of the load balancer VIP.
|
||||
</para>
|
||||
<para>Example: Create a load balancer</para>
|
||||
</wadl:doc>
|
||||
@ -291,10 +291,9 @@
|
||||
</method>
|
||||
<method name="PUT" id="updateLoadBalancerv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update load balancer">
|
||||
<para role="shortdesc">Updates a specified load balancer.</para>
|
||||
<para role="shortdesc">Updates a load balancer.</para>
|
||||
<para>
|
||||
This operation updates the attributes of the specified load
|
||||
balancer. Upon successful validation of the request, the
|
||||
Upon successful validation of the request, the
|
||||
service returns the <code>Accepted (202)</code> response code.
|
||||
A caller should check that the load balancer
|
||||
<code>provisioning_status</code> has changed to
|
||||
@ -333,10 +332,11 @@
|
||||
</response> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
<method name="DELETE" id="deleteLoadBalancerv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove load balancer">
|
||||
<para role="shortdesc">Removes a specified load balancer.</para>
|
||||
<para role="shortdesc">Removes a load balancer and its
|
||||
associated configuration from the tenant account.
|
||||
</para>
|
||||
<para>
|
||||
This operation removes the specified load balancer and its
|
||||
associated configuration from the tenant account. Any and all
|
||||
Any and all
|
||||
configuration data is immediately purged and cannot be
|
||||
recovered.
|
||||
</para>
|
||||
@ -386,8 +386,7 @@
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
Some attributes receive default values if not specified in the
|
||||
request:
|
||||
Some attributes receive default values if you omit them from the request:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
@ -415,22 +414,22 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>admin_state_up</code>. The default is <code>true</code>.
|
||||
<code>admin_state_up</code>. Default is <code>true</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>name</code>. The default is an empty string.
|
||||
<code>name</code>. Default is an empty string.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>description</code>. The default is an empty string.
|
||||
<code>description</code>. Default is an empty string.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>connection_limit</code>. The default is
|
||||
<code>connection_limit</code>. Default is
|
||||
<code>-1</code>, which indicates an infinite limit.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -509,7 +508,7 @@
|
||||
<method name="GET" id="showListenerv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show listener details">
|
||||
<para role="shortdesc">Shows details for a specified listener.</para>
|
||||
<para role="shortdesc">Shows details for a listener.</para>
|
||||
<para>
|
||||
This operation returns a listener object identified by
|
||||
<code>listener_id</code>. If the user is not an administrative
|
||||
@ -545,9 +544,9 @@
|
||||
</response> &fault401; &fault403; &fault404; &fault409; &fault413; &fault500; &fault503;</method>
|
||||
<method name="PUT" id="updateListenerv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update listener">
|
||||
<para role="shortdesc">Updates a specified listener.</para>
|
||||
<para role="shortdesc">Updates a listener.</para>
|
||||
<para>
|
||||
This operation updates the attributes of a specified listener.
|
||||
This operation updates the attributes of a listener.
|
||||
Upon successful validation of the request, the service returns
|
||||
the HTTP <code>Accepted (202)</code> response code.
|
||||
</para>
|
||||
@ -593,9 +592,9 @@
|
||||
</response> &fault500; &fault503; &fault401; &fault400;&fault413;</method>
|
||||
<method name="DELETE" id="deleteListenerv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove listener">
|
||||
<para role="shortdesc">Removes a specified listener.</para>
|
||||
<para role="shortdesc">Removes a listener.</para>
|
||||
<para>
|
||||
This operation removes a specified listener and its associated
|
||||
This operation removes a listener and its associated
|
||||
configuration from the tenant account. Any and all
|
||||
configuration data is immediately purged and cannot be
|
||||
recovered.
|
||||
@ -663,13 +662,13 @@
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
Some attributes receive default values if not specified in the request:
|
||||
Some attributes receive default values if you omit them from the request:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>admin_state_up</code>. The default is <code>true</code>.</para></listitem>
|
||||
<listitem><para><code>name</code>. The default is an empty string.</para></listitem>
|
||||
<listitem><para><code>description</code>. The default is an empty string.</para></listitem>
|
||||
<listitem><para><code>session_persistence</code>. The default is an empty dictionary.</para></listitem>
|
||||
<listitem><para><code>admin_state_up</code>. Default is <code>true</code>.</para></listitem>
|
||||
<listitem><para><code>name</code>. Default is an empty string.</para></listitem>
|
||||
<listitem><para><code>description</code>. Default is an empty string.</para></listitem>
|
||||
<listitem><para><code>session_persistence</code>. Default is an empty dictionary.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
If the request cannot be fulfilled due to insufficient or
|
||||
@ -709,9 +708,7 @@
|
||||
</response> &fault401; &fault404; &fault409; &fault413; &fault500; &fault503; </method>
|
||||
<method name="GET" id="listPoolsv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pools">
|
||||
<para role="shortdesc">Lists pools.</para>
|
||||
<para>
|
||||
This operation lists all pools that are associated with your
|
||||
<para role="shortdesc">Lists all pools that are associated with your
|
||||
tenant account.
|
||||
</para>
|
||||
<para>
|
||||
@ -743,7 +740,7 @@
|
||||
<method name="GET" id="showPoolv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show pool details">
|
||||
<para role="shortdesc">Shows details for a specified pool.</para>
|
||||
<para role="shortdesc">Shows details for a pool.</para>
|
||||
<para>
|
||||
This operation returns a pool object identified by
|
||||
<code>pool_id</code>. If the user is not an administrative
|
||||
@ -779,9 +776,9 @@
|
||||
</method>
|
||||
<method name="PUT" id="updatePoolv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update pool">
|
||||
<para role="shortdesc">Updates a specified pool.</para>
|
||||
<para role="shortdesc">Updates a pool.</para>
|
||||
<para>
|
||||
This operation updates the attributes of the specified pool.
|
||||
This operation updates the attributes of a pool.
|
||||
Upon successful validation of the request, the service returns
|
||||
the HTTP <code>Accepted (202)</code> response code.
|
||||
</para>
|
||||
@ -825,9 +822,9 @@
|
||||
</response> &fault400; &fault401; &fault413; &fault500; &fault503;</method>
|
||||
<method name="DELETE" id="deletePoolv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove pool">
|
||||
<para role="shortdesc">Removes a specified pool.</para>
|
||||
<para role="shortdesc">Removes a pool.</para>
|
||||
<para>
|
||||
This operation removes a specified pool and its associated
|
||||
This operation removes a pool and its associated
|
||||
configuration from the tenant account. Any and all
|
||||
configuration data is immediately purged and cannot be recovered.
|
||||
</para>
|
||||
@ -874,10 +871,10 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>Some attributes receive default values if not specified in the request:</para>
|
||||
<para>Some attributes receive default values if you omit them from the request:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>admin_state_up</code>. The default is <code>true</code>.</para></listitem>
|
||||
<listitem><para><code>weight</code>. The default is <code>1</code>.</para></listitem>
|
||||
<listitem><para><code>admin_state_up</code>. Default is <code>true</code>.</para></listitem>
|
||||
<listitem><para><code>weight</code>. Default is <code>1</code>.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
If you omit the <code>subnet_id</code> parameter, LBaaS
|
||||
@ -918,7 +915,7 @@
|
||||
</response> &fault401; &fault404; &fault409; &fault413; &fault500; &fault503; </method>
|
||||
<method name="GET" id="listMembersv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pool members">
|
||||
<para role="shortdesc">Lists members of a specified pool.</para>
|
||||
<para role="shortdesc">Lists members of a pool.</para>
|
||||
<para>
|
||||
Lists all members that are associated with a pool that is
|
||||
associated with your tenant account. The list of members
|
||||
@ -950,7 +947,7 @@
|
||||
<method name="GET" id="showMemberv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show pool member details">
|
||||
<para role="shortdesc">Shows details for a specified pool member.</para>
|
||||
<para role="shortdesc">Shows details for a pool member.</para>
|
||||
<para>
|
||||
This operation returns a member object identified by
|
||||
<code>member_id</code> that belongs to a pool object
|
||||
@ -984,9 +981,8 @@
|
||||
<method name="PUT" id="updateMemberv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Update pool member">
|
||||
<para role="shortdesc">Updates a specified member of a pool.</para>
|
||||
<para role="shortdesc">Updates attributes of a pool member.</para>
|
||||
<para>
|
||||
This operation updates the attributes of the specified pool.
|
||||
Upon successful validation of the request, the service returns
|
||||
the HTTP <code>OK (200)</code> response code.
|
||||
</para>
|
||||
@ -1025,10 +1021,11 @@
|
||||
</response> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
<method name="DELETE" id="deleteMemberv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove member from pool">
|
||||
<para role="shortdesc">Removes a member from a pool.</para>
|
||||
<para role="shortdesc">Removes a member from a pool and its associated
|
||||
configuration from the tenant account.
|
||||
</para>
|
||||
<para>
|
||||
This operation removes the specified member and its associated
|
||||
configuration from the tenant account. Any and all
|
||||
Any and all
|
||||
configuration data is immediately purged and cannot be recovered.
|
||||
</para>
|
||||
<para>
|
||||
@ -1060,12 +1057,16 @@
|
||||
<listitem><para><code>max_retries</code>. Number of failed health checks before marked as OFFLINE.</para></listitem>
|
||||
<listitem><para><code>pool_id</code>. The pool that this health monitor will monitor.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>Some attributes will receive default values if not specified in the request and are only useful when health monitor type of HTTP(S) is specified:</para>
|
||||
<para>
|
||||
Some attributes receive default values if you omit them from
|
||||
the request, and are only useful when you specify a health
|
||||
monitor type of HTTP(S):
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>http_method</code>. The default is GET.</para></listitem>
|
||||
<listitem><para><code>url_path</code>. The default is <code>/</code>.</para></listitem>
|
||||
<listitem><para><code>http_method</code>. Default is GET.</para></listitem>
|
||||
<listitem><para><code>url_path</code>. Default is <code>/</code>.</para></listitem>
|
||||
<listitem><para><code>expected_codes</code>. The expected http status codes to get from a successful health check. Default is 200.</para></listitem>
|
||||
<listitem><para><code>admin_state_up</code>. The default is true.</para></listitem>
|
||||
<listitem><para><code>admin_state_up</code>. Default is true.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
If the request cannot be fulfilled due to insufficient data or
|
||||
@ -1133,7 +1134,7 @@
|
||||
<method name="GET" id="showHealthMonitorv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||
title="Show health monitor details">
|
||||
<para role="shortdesc">Shows details for a specified health monitor.</para>
|
||||
<para role="shortdesc">Shows details for a health monitor.</para>
|
||||
<para>
|
||||
This operation returns a health monitor object identified by
|
||||
<code>health_monitor_id</code>. If the user is not an
|
||||
@ -1170,10 +1171,9 @@
|
||||
</method>
|
||||
<method name="PUT" id="updateHealthMonitorv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update health monitor">
|
||||
<para role="shortdesc">Updates a specified health monitor.</para>
|
||||
<para role="shortdesc">Updates a health monitor.</para>
|
||||
<para>
|
||||
This operation updates the attributes of the specified health
|
||||
monitor. Upon successful validation of the request, the
|
||||
Upon successful validation of the request, the
|
||||
service returns the HTTP <code>Accepted (202)</code> response code.
|
||||
</para>
|
||||
<para>
|
||||
@ -1211,10 +1211,11 @@
|
||||
</response> &fault400; &fault401; &fault413; &fault500; &fault503; </method>
|
||||
<method name="DELETE" id="deleteHealthMonitorv2">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Remove health monitor">
|
||||
<para role="shortdesc">Removes a specified health monitor.</para>
|
||||
<para role="shortdesc">Removes a health monitor and its
|
||||
associated configuration from the tenant account.
|
||||
</para>
|
||||
<para>
|
||||
This operation removes the specified health monitor and its
|
||||
associated configuration from the tenant account. Any and all
|
||||
Any and all
|
||||
configuration data is immediately purged and cannot be recovered.
|
||||
</para>
|
||||
<para>
|
||||
|
@ -100,7 +100,7 @@
|
||||
<method name="GET" id="showMultiNetwork">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show details for a network with multiple segments">
|
||||
<para role="shortdesc">Shows details for a specified
|
||||
<para role="shortdesc">Shows details for a
|
||||
network with multiple segments.</para>
|
||||
</wadl:doc>
|
||||
<response status="200"> &networkShowResponseParams;
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user