Files
openstack-manuals/doc/user-guide/section_object-api-discoverability.xml
Erik Wilson 2cb5510929 Adds links to and from Discoverability topic in End User Guide
With the moving of the Object Storage API content from a
long-form dev guide to a specification, some topics needed
To be added to the End User Guide.

Change-Id: I7612f3fc5226b627f203a48e669abc9cd1e69a76
Partial-bug: 1392382
2015-02-12 19:53:10 +00:00

56 lines
2.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [ <!ENTITY % openstack SYSTEM "../common/entities/openstack.ent"> %openstack; ]>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="discoverability">
<title>Discoverability</title>
<para>Your Object Storage system might not enable all features
that this document describes. These features are:</para>
<itemizedlist role="compact">
<listitem>
<para><xref linkend="large-object-creation"/></para>
</listitem>
<listitem>
<para><xref linkend="archive-auto-extract"/></para>
</listitem>
<listitem>
<para><xref linkend="expire-objects"/></para>
</listitem>
<listitem>
<para><xref linkend="bulk-delete"/></para>
</listitem>
<listitem>
<para><xref linkend="static-website"/></para>
</listitem>
</itemizedlist>
<para>To discover which features are enabled in your Object
Storage system, use the <literal>/info</literal> request.</para>
<para>To use the <literal>/info</literal> request, send a &GET;
request using the <literal>/info</literal> path to the Object
Store endpoint as shown in this example:</para>
<screen><prompt>$</prompt> <userinput>curl https://storage.example.com/info</userinput></screen>
<para>This example shows a truncated response body:</para>
<programlisting language="json">{
"swift":{
"version":"1.11.0"
},
"staticweb":{
},
"tempurl":{
}
}</programlisting>
<para>This output shows that the Object Storage system has enabled
the static website and temporary URL features.</para>
<?sbr?>
<note>
<para>In some cases, the <literal>/info</literal> request will
return an error. This could be because your service
provider has disabled the <literal>/info</literal> request
function, or because you are using an older version that
does not support it.</para>
</note>
</section>