Update rescue and unrescue operations
Change-Id: I1f4e1bb105e6c6eb440e510276848369efdb9f33 Closes-Bug: #1204356 Partial-Bug: #1488144
This commit is contained in:
@@ -39,7 +39,7 @@
|
|||||||
<!-- version is set in ../pom.xml file -->
|
<!-- version is set in ../pom.xml file -->
|
||||||
<executions>
|
<executions>
|
||||||
<!-- Configuration for OpenStack API Guide -->
|
<!-- Configuration for OpenStack API Guide -->
|
||||||
<execution>
|
<execution>
|
||||||
<id>os-api-ref</id>
|
<id>os-api-ref</id>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>generate-pdf</goal>
|
<goal>generate-pdf</goal>
|
||||||
@@ -105,7 +105,7 @@
|
|||||||
<pdfFilenameBase>api-ref-compute-v2.1</pdfFilenameBase>
|
<pdfFilenameBase>api-ref-compute-v2.1</pdfFilenameBase>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
<execution>
|
<execution>
|
||||||
<id>os-api-ref-database-v1</id>
|
<id>os-api-ref-database-v1</id>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>generate-pdf</goal>
|
<goal>generate-pdf</goal>
|
||||||
|
@@ -1,5 +1,7 @@
|
|||||||
{
|
{
|
||||||
"server": {
|
"server": {
|
||||||
|
"accessIPv4": "1.2.3.4",
|
||||||
|
"accessIPv6": "80fe::",
|
||||||
"addresses": {
|
"addresses": {
|
||||||
"private": [
|
"private": [
|
||||||
{
|
{
|
||||||
@@ -15,7 +17,7 @@
|
|||||||
"id": "1",
|
"id": "1",
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/flavors/1",
|
"href": "http://openstack.example.com/openstack/flavors/1",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -26,7 +28,7 @@
|
|||||||
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
|
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -34,11 +36,11 @@
|
|||||||
"key_name": null,
|
"key_name": null,
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/v2.1/servers/2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
"href": "http://openstack.example.com/v2/openstack/servers/2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
||||||
"rel": "self"
|
"rel": "self"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/servers/2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
"href": "http://openstack.example.com/openstack/servers/2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
@@ -1,5 +1,7 @@
|
|||||||
{
|
{
|
||||||
"server": {
|
"server": {
|
||||||
|
"accessIPv4": "1.2.3.4",
|
||||||
|
"accessIPv6": "80fe::",
|
||||||
"addresses": {
|
"addresses": {
|
||||||
"private": [
|
"private": [
|
||||||
{
|
{
|
||||||
@@ -15,7 +17,7 @@
|
|||||||
"id": "1",
|
"id": "1",
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/flavors/1",
|
"href": "http://openstack.example.com/openstack/flavors/1",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -26,7 +28,7 @@
|
|||||||
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
|
"href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -34,11 +36,11 @@
|
|||||||
"key_name": null,
|
"key_name": null,
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/v2.1/servers/edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
"href": "http://openstack.example.com/v2/openstack/servers/edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
||||||
"rel": "self"
|
"rel": "self"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/servers/edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
"href": "http://openstack.example.com/openstack/servers/edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"rescue": {
|
"rescue": {
|
||||||
"adminPass": "MySecretPass",
|
"admin_pass": "MySecretPass",
|
||||||
"rescue_image_ref": "70a599e0-31e7-49b7-b260-868f441e862b"
|
"rescue_image_ref": "70a599e0-31e7-49b7-b260-868f441e862b"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,3 +1,3 @@
|
|||||||
{
|
{
|
||||||
"adminPass": "MySecretPass"
|
"admin_pass": "MySecretPass"
|
||||||
}
|
}
|
||||||
|
@@ -10,7 +10,8 @@
|
|||||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||||
xmlns:csapi="http://docs.openstack.org/identity/api/v3">
|
xmlns:csapi="http://docs.openstack.org/identity/api/v3"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
<resources base="https://servers.api.openstack.com"
|
<resources base="https://servers.api.openstack.com"
|
||||||
xml:id="os-server-actions-v2.1">
|
xml:id="os-server-actions-v2.1">
|
||||||
<resource id="v2.1" path="//v2.1">
|
<resource id="v2.1" path="//v2.1">
|
||||||
@@ -31,6 +32,7 @@
|
|||||||
<method href="#stop"/>
|
<method href="#stop"/>
|
||||||
<method href="#attachVolume"/>
|
<method href="#attachVolume"/>
|
||||||
<method href="#rescue"/>
|
<method href="#rescue"/>
|
||||||
|
<method href="#unrescue"/>
|
||||||
</resource>
|
</resource>
|
||||||
</resource>
|
</resource>
|
||||||
</resource>
|
</resource>
|
||||||
@@ -110,12 +112,12 @@
|
|||||||
action in the request body.
|
action in the request body.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
A successfully resized server shows a status of
|
A successfully resized server shows a
|
||||||
<code>VERIFY_RESIZE</code>, a vm_status of
|
<code>VERIFY_RESIZE</code> status, <code>RESIZED</code> VM
|
||||||
<code>RESIZED</code>, and a migration_status of
|
status, and <code>finished</code> migration status. If you set
|
||||||
<code>finished</code>. If you set the auto_confirm option of
|
the <code>auto_confirm</code> option of the Compute service to
|
||||||
the Compute service to <code>True</code>, the Compute service
|
<code>True</code>, the Compute service automatically confirms
|
||||||
automatically confirms the resize operation.
|
the resize operation.
|
||||||
</para>
|
</para>
|
||||||
<para>Preconditions</para>
|
<para>Preconditions</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
@@ -303,12 +305,16 @@
|
|||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
<para>Troubleshooting</para>
|
<para>Troubleshooting</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para>If the server status does not change
|
<listitem>
|
||||||
to <code>ACTIVE</code>, the start operation failed. Ensure
|
<para>
|
||||||
that you meet the preconditions and run the request again.
|
If the server status does not change to
|
||||||
If the request fails again, investigate whether another
|
<code>ACTIVE</code>, the start operation failed.
|
||||||
operation is running that causes a race condition.
|
Ensure that you meet the preconditions and run the
|
||||||
</para></listitem>
|
request again. If the request fails again, investigate
|
||||||
|
whether another operation is running that causes a
|
||||||
|
race condition.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<request>
|
<request>
|
||||||
@@ -463,25 +469,44 @@
|
|||||||
If you omit an image reference, the base image reference is
|
If you omit an image reference, the base image reference is
|
||||||
used by default.
|
used by default.
|
||||||
</para>
|
</para>
|
||||||
|
<para>Asynchronous Postconditions</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
After you successfully rescue a server and make a
|
||||||
|
<code>GET
|
||||||
|
/v2.1/{tenant_id}/servers/{server_id}</code>
|
||||||
|
request, its status changes to <code>UNRESCUE</code>.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<request>
|
<request>
|
||||||
<representation mediaType="application/json">
|
<representation mediaType="application/json">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Rescue server: JSON request">
|
xml:lang="EN" title="Rescue server: JSON request">
|
||||||
<xsdxt:code
|
<xsdxt:code
|
||||||
href="../api_samples/servers/server-rescue-req.json"
|
href="../api_samples/os-rescue/server-rescue-req.json"
|
||||||
|
/>
|
||||||
|
</wadl:doc>
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN" title="Rescue server with image: JSON request">
|
||||||
|
<xsdxt:code
|
||||||
|
href="../api_samples/os-rescue/server-rescue-req-with-image-ref.json"
|
||||||
/>
|
/>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<param name="rescue" style="plain" type="xsd:string"
|
<param name="rescue" style="plain" type="xsd:string"
|
||||||
required="true">
|
required="true">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Rescue action"
|
xml:lang="EN" title="Rescue action"
|
||||||
><para>Specify the <code>rescue</code>
|
>
|
||||||
action in the request
|
<para>
|
||||||
body.</para></wadl:doc>
|
Specify the <code>rescue</code> action in the
|
||||||
|
request body.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
<param name="adminPass" style="plain"
|
<param name="adminPass" style="plain"
|
||||||
type="csapi:string">
|
type="csapi:string" required="false">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Admin password">
|
xml:lang="EN" title="Admin password">
|
||||||
<para>
|
<para>
|
||||||
@@ -492,7 +517,7 @@
|
|||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
<param name="rescue_image_ref" style="plain"
|
<param name="rescue_image_ref" style="plain"
|
||||||
type="csapi:string">
|
type="csapi:string" required="false">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Image reference for rescue">
|
xml:lang="EN" title="Image reference for rescue">
|
||||||
<para>
|
<para>
|
||||||
@@ -513,10 +538,68 @@
|
|||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Extended rescue server: JSON response">
|
xml:lang="EN" title="Extended rescue server: JSON response">
|
||||||
<xsdxt:code
|
<xsdxt:code
|
||||||
href="../api_samples/servers/server-get-resp-rescue.json"
|
href="../api_samples/os-rescue/server-rescue.json"
|
||||||
/>
|
/>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
|
<param name="adminPass" style="plain"
|
||||||
|
type="csapi:string" required="true">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN" title="Admin password">
|
||||||
|
<para>
|
||||||
|
The password that enables the administrator to
|
||||||
|
access the rescued instance.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
</representation>
|
</representation>
|
||||||
</response>
|
</response>
|
||||||
</method>
|
</method>
|
||||||
|
<method name="POST" id="unrescue">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||||
|
title="Unrescue server">
|
||||||
|
<para role="shortdesc">
|
||||||
|
Unrescues a specified server. Changes status to
|
||||||
|
<code>ACTIVE</code>.
|
||||||
|
</para>
|
||||||
|
<para>Preconditions</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>The specified server must exist.</para></listitem>
|
||||||
|
<listitem><para>You can only unrescue a server
|
||||||
|
when its status is <code>RESCUE</code>.</para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
<para>Asynchronous Postconditions</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
After you successfully unrescue a server and make a
|
||||||
|
<code>GET
|
||||||
|
/v2.1/{tenant_id}/servers/{server_id}</code>
|
||||||
|
request, its status changes to <code>ACTIVE</code>.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</wadl:doc>
|
||||||
|
<request>
|
||||||
|
<representation mediaType="application/json">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN"
|
||||||
|
title="Unrescue server: JSON request">
|
||||||
|
<xsdxt:code
|
||||||
|
href="../api_samples/os-rescue/server-unrescue-req.json"
|
||||||
|
/>
|
||||||
|
</wadl:doc>
|
||||||
|
<param name="unrescue" style="plain" type="xsd:string"
|
||||||
|
required="true">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN" title="Unrescue action"
|
||||||
|
>
|
||||||
|
<para>
|
||||||
|
Specify the <code>unrescue</code>
|
||||||
|
action in the request body.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
|
</representation>
|
||||||
|
</request>
|
||||||
|
<response status="202"/>
|
||||||
|
</method>
|
||||||
</application>
|
</application>
|
||||||
|
@@ -1,16 +1,18 @@
|
|||||||
{
|
{
|
||||||
"server": {
|
"server": {
|
||||||
"accessIPv4": "",
|
"accessIPv4": "1.2.3.4",
|
||||||
"accessIPv6": "",
|
"accessIPv6": "80fe::",
|
||||||
"addresses": {
|
"addresses": {
|
||||||
"private": [
|
"private": [
|
||||||
{
|
{
|
||||||
"addr": "192.168.0.3",
|
"addr": "192.168.0.3",
|
||||||
|
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
|
||||||
|
"OS-EXT-IPS:type": "fixed",
|
||||||
"version": 4
|
"version": 4
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"created": "2012-09-19T09:22:27Z",
|
"created": "2013-09-18T07:22:09Z",
|
||||||
"flavor": {
|
"flavor": {
|
||||||
"id": "1",
|
"id": "1",
|
||||||
"links": [
|
"links": [
|
||||||
@@ -20,8 +22,8 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"hostId": "c02c15d17499304e9893d9fc41c415f5096f8aa880bc651cac092650",
|
"hostId": "f04994c5b4aac1cacbb83b09c2506e457d97dd54f620961624574690",
|
||||||
"id": "7e21a264-6cc1-4d90-b7b5-f9f49cec3a85",
|
"id": "2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
||||||
"image": {
|
"image": {
|
||||||
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
||||||
"links": [
|
"links": [
|
||||||
@@ -31,13 +33,14 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"key_name": null,
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/v2/openstack/servers/7e21a264-6cc1-4d90-b7b5-f9f49cec3a85",
|
"href": "http://openstack.example.com/v2/openstack/servers/2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
||||||
"rel": "self"
|
"rel": "self"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/openstack/servers/7e21a264-6cc1-4d90-b7b5-f9f49cec3a85",
|
"href": "http://openstack.example.com/openstack/servers/2fd0c66b-50af-41d2-9253-9fa41e7e8dd8",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@@ -47,7 +50,7 @@
|
|||||||
"name": "new-server-test",
|
"name": "new-server-test",
|
||||||
"status": "RESCUE",
|
"status": "RESCUE",
|
||||||
"tenant_id": "openstack",
|
"tenant_id": "openstack",
|
||||||
"updated": "2012-09-19T09:22:27Z",
|
"updated": "2013-09-18T07:22:11Z",
|
||||||
"user_id": "fake"
|
"user_id": "fake"
|
||||||
}
|
}
|
||||||
}
|
}
|
@@ -1,16 +1,18 @@
|
|||||||
{
|
{
|
||||||
"server": {
|
"server": {
|
||||||
"accessIPv4": "",
|
"accessIPv4": "1.2.3.4",
|
||||||
"accessIPv6": "",
|
"accessIPv6": "80fe::",
|
||||||
"addresses": {
|
"addresses": {
|
||||||
"private": [
|
"private": [
|
||||||
{
|
{
|
||||||
"addr": "192.168.0.3",
|
"addr": "192.168.0.3",
|
||||||
|
"OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
|
||||||
|
"OS-EXT-IPS:type": "fixed",
|
||||||
"version": 4
|
"version": 4
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"created": "2012-09-19T09:22:28Z",
|
"created": "2013-09-18T07:22:09Z",
|
||||||
"flavor": {
|
"flavor": {
|
||||||
"id": "1",
|
"id": "1",
|
||||||
"links": [
|
"links": [
|
||||||
@@ -20,8 +22,8 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"hostId": "a9410a6a8cb87328b1c43cda5c5a15fc860e977d14feb2c9528a2450",
|
"hostId": "53cd4520a6cc639eeabcae4a0512b93e4675d431002e0b60e2dcfc04",
|
||||||
"id": "f1ec6ac3-5379-4cdc-af9a-6ddc29656e4f",
|
"id": "edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
||||||
"image": {
|
"image": {
|
||||||
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
|
||||||
"links": [
|
"links": [
|
||||||
@@ -31,13 +33,14 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"key_name": null,
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/v2/openstack/servers/f1ec6ac3-5379-4cdc-af9a-6ddc29656e4f",
|
"href": "http://openstack.example.com/v2/openstack/servers/edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
||||||
"rel": "self"
|
"rel": "self"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"href": "http://openstack.example.com/openstack/servers/f1ec6ac3-5379-4cdc-af9a-6ddc29656e4f",
|
"href": "http://openstack.example.com/openstack/servers/edfc3905-1f3c-4819-8fc3-a7d8131cfa22",
|
||||||
"rel": "bookmark"
|
"rel": "bookmark"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@@ -48,7 +51,7 @@
|
|||||||
"progress": 0,
|
"progress": 0,
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
"tenant_id": "openstack",
|
"tenant_id": "openstack",
|
||||||
"updated": "2012-09-19T09:22:28Z",
|
"updated": "2013-09-18T07:22:12Z",
|
||||||
"user_id": "fake"
|
"user_id": "fake"
|
||||||
}
|
}
|
||||||
}
|
}
|
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"rescue": {
|
||||||
|
"adminPass": "MySecretPass",
|
||||||
|
"rescue_image_ref": "70a599e0-31e7-49b7-b260-868f441e862b"
|
||||||
|
}
|
||||||
|
}
|
@@ -10,7 +10,8 @@
|
|||||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||||
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
|
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
<resources base="https://servers.api.openstack.com"
|
<resources base="https://servers.api.openstack.com"
|
||||||
xml:id="os-rescue-v2">
|
xml:id="os-rescue-v2">
|
||||||
<resource id="version" type="#VersionDetails" path="//v2">
|
<resource id="version" type="#VersionDetails" path="//v2">
|
||||||
@@ -45,7 +46,24 @@
|
|||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||||
title="Rescue server">
|
title="Rescue server">
|
||||||
<para role="shortdesc">Puts a server in rescue mode.
|
<para role="shortdesc">Puts a server in rescue mode.
|
||||||
Changes status to RESCUE.</para>
|
Changes status to <code>RESCUE</code>.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
If you specify the <code>rescue_image_ref</code> extended
|
||||||
|
attribute, the specified image is used to rescue the instance.
|
||||||
|
If you omit an image reference, the base image reference is
|
||||||
|
used by default.
|
||||||
|
</para>
|
||||||
|
<para>Asynchronous Postconditions</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
After you successfully unrescue a server and make a
|
||||||
|
<code>GET
|
||||||
|
/v2.1/{tenant_id}/servers/{server_id}</code>
|
||||||
|
request, its status changes to <code>ACTIVE</code>.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<request>
|
<request>
|
||||||
<representation mediaType="application/json">
|
<representation mediaType="application/json">
|
||||||
@@ -55,6 +73,12 @@
|
|||||||
href="../api_samples/os-rescue/server-rescue-req.json"
|
href="../api_samples/os-rescue/server-rescue-req.json"
|
||||||
/>
|
/>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN" title="Rescue server with image: JSON request">
|
||||||
|
<xsdxt:code
|
||||||
|
href="../api_samples/os-rescue/server-rescue-req-with-image-ref.json"
|
||||||
|
/>
|
||||||
|
</wadl:doc>
|
||||||
</representation>
|
</representation>
|
||||||
<representation mediaType="application/xml">
|
<representation mediaType="application/xml">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
@@ -79,16 +103,41 @@
|
|||||||
Generate a new password if none is
|
Generate a new password if none is
|
||||||
provided.</para></wadl:doc>
|
provided.</para></wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
|
<param name="rescue_image_ref" style="plain"
|
||||||
|
type="csapi:string" required="false">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN" title="Image reference for rescue">
|
||||||
|
<para>
|
||||||
|
The image reference to use to rescue your server
|
||||||
|
instance. Specify the image reference by ID or
|
||||||
|
full URL.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
If you omit an image reference, default is the
|
||||||
|
base image reference.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
</representation>
|
</representation>
|
||||||
</request>
|
</request>
|
||||||
<response status="200">
|
<response status="200">
|
||||||
<representation mediaType="application/json">
|
<representation mediaType="application/json">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Rescue server: JSON response">
|
xml:lang="EN" title="Extended rescue server: JSON response">
|
||||||
<xsdxt:code
|
<xsdxt:code
|
||||||
href="../api_samples/os-rescue/server-rescue.json"
|
href="../api_samples/os-rescue/server-rescue.json"
|
||||||
/>
|
/>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
|
<param name="adminPass" style="plain"
|
||||||
|
type="csapi:string" required="true">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xml:lang="EN" title="Admin password">
|
||||||
|
<para>
|
||||||
|
The password that enables the administrator to
|
||||||
|
access the rescued instance.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
|
</param>
|
||||||
</representation>
|
</representation>
|
||||||
<representation mediaType="application/xml">
|
<representation mediaType="application/xml">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
@@ -103,7 +152,25 @@
|
|||||||
<method name="POST" id="unrescue">
|
<method name="POST" id="unrescue">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
|
||||||
title="Unrescue server">
|
title="Unrescue server">
|
||||||
<para role="shortdesc">Unrescues a server.</para>
|
<para role="shortdesc">
|
||||||
|
Unrescues a server. Changes status to <code>ACTIVE</code>.
|
||||||
|
</para>
|
||||||
|
<para>Preconditions</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para>The specified server must exist.</para></listitem>
|
||||||
|
<listitem><para>You can only unrescue a server
|
||||||
|
when its status is <code>RESCUE</code>.</para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
<para>Asynchronous Postconditions</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
After you successfully unrescue a server and make a
|
||||||
|
<code>GET
|
||||||
|
/v2.1/{tenant_id}/servers/{server_id}</code>
|
||||||
|
request, its status changes to <code>ACTIVE</code>.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<request>
|
<request>
|
||||||
<representation mediaType="application/json">
|
<representation mediaType="application/json">
|
||||||
@@ -126,9 +193,12 @@
|
|||||||
required="true">
|
required="true">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||||
xml:lang="EN" title="Unrescue action"
|
xml:lang="EN" title="Unrescue action"
|
||||||
><para>Specify the <code>unrescue</code>
|
>
|
||||||
action in the request
|
<para>
|
||||||
body.</para></wadl:doc>
|
Specify the <code>unrescue</code>
|
||||||
|
action in the request body.
|
||||||
|
</para>
|
||||||
|
</wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
</representation>
|
</representation>
|
||||||
</request>
|
</request>
|
||||||
|
Reference in New Issue
Block a user