openstack/api-site
Code Issues Proposed changes

Merge "Added os-availability-zone API introductions in api-ref-compute-v2-ext.html"

Browse Source
This commit is contained in:
Jenkins 2015-04-22 02:36:47 +00:00 committed by Gerrit Code Review
commit ad939716f4
6 changed files with 158 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/src/docbkx/ch_compute-v2-ext.xml
View File

@ -21,6 +21,13 @@
The Compute API returns the <code>403 forbidden</code> error code if
you exceed your allotted quota for the operation.
</para></note>
<section xml:id="os-availability-zone">
<title>Availiability zones (os-availability-zone)</title>
<para>Gets availability zone information.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-availability-zone.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-action">
<title>Server admin actions (action)</title>
<para>Administrator only. Performs actions on a server. Specify

54
api-ref/src/wadls/compute-api/src/v2/api_samples/os-availability-zone/availability-zone-detail-resp.json Normal file
View File

@ -0,0 +1,54 @@
{
"availabilityZoneInfo": [
{
"zoneState": {
"available": true
},
"hosts": {
"test-host": {
"nova-conductor": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-cert": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-consoleauth": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-scheduler": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:55.000000"
},
"nova-network": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:54.000000"
}
}
},
"zoneName": "internal"
},
{
"zoneState": {
"available": true
},
"hosts": {
"test-host": {
"nova-compute": {
"available": true,
"active": true,
"updated_at": "2015-04-16T08:58:56.000000"
}
}
},
"zoneName": "nova"
}
]
}

2
api-ref/src/wadls/compute-api/src/v2/api_samples/os-availability-zone/availability-zone-post-req.json
View File

@ -10,7 +10,7 @@
"personality": [
{
"path": "/etc/banner.txt",
"contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
"contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2gg=="
}
]
}

2
api-ref/src/wadls/compute-api/src/v2/api_samples/os-availability-zone/availability-zone-post-resp.json
View File

@ -1,6 +1,6 @@
{
"server": {
"adminPass": "k4pKvTfcA4gY",
"adminPass": "k6pKvTfcA4gY",
"id": "3e45fa2a-5204-466f-a684-c2a8e1c82d7f",
"links": [
{

11
api-ref/src/wadls/compute-api/src/v2/api_samples/os-availability-zone/availability-zone-resp.json Normal file
View File

@ -0,0 +1,11 @@
{
"availabilityZoneInfo": [
{
"zoneState": {
"available": true
},
"hosts": null,
"zoneName": "nova"
}
]
}

84
api-ref/src/wadls/compute-api/src/v2/ext/os-availability-zone.wadl Normal file
View File

@ -0,0 +1,84 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2015 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v1.1">
<resources base="https://servers.api.openstack.com"
xml:id="os-availability-zone-v2">
<resource id="version" type="#VersionDetails" path="//v2">
<resource id="Servers" path="servers">
<method href="#addAvailabilityZone"/>
</resource>
<resource path="os-availability-zone" id="os-availability-zone">
<method href="#getAvailabilityZone"/>
<resource path="detail" id="detail">
<method href="#getAvailabilityZoneDetails"/>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="getAvailabilityZone">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get availability zone information">
<para role="shortdesc">Gets availability zone information.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Get availability zone information: JSON response">
<xsdxt:code
href="../api_samples/os-availability-zone/availability-zone-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="GET" id="getAvailabilityZoneDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Get detailed availability zone information">
<para role="shortdesc">Gets detailed availability zone information.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Get detailed availability zone information: JSON response">
<xsdxt:code
href="../api_samples/os-availability-zone/availability-zone-detail-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="addAvailabilityZone">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create server with availability zone">
<para role="shortdesc">Creates a server with an availability zone.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Create server with availability zone: JSON request">
<xsdxt:code
href="../api_samples/os-availability-zone/availability-zone-post-req.json"
/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="Create server with availability zone: JSON response">
<xsdxt:code
href="../api_samples/os-availability-zone/availability-zone-post-resp.json"
/>
</wadl:doc>
</representation>
</response>
</method>
</application>