openstack/api-site
Code Issues Proposed changes

Added os-instance-actions extension to api-ref page

Browse Source 
bug: #1122205

Change-Id: I63809d57df4440ca3a2055677ec93529325b5f09
author: Diane Fleming
This commit is contained in:
Diane Fleming 2013-03-18 15:32:45 -05:00
parent 8a1ccf22ec
commit d776693471
12 changed files with 209 additions and 585 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*.bak
*.DS_Store
target/

21
api-ref/src/docbkx/api-ref.xml
View File

@ -9,7 +9,9 @@
<copyright>
<year>2010-2013</year>
</copyright>
<legalnotice role="apache2"><para/></legalnotice>
<legalnotice role="apache2">
<para/>
</legalnotice>
</info>
<preface xml:id="Overview">
<title>OpenStack API Reference</title>
@ -98,8 +100,8 @@
</section>
<section xml:id="ext-os-server-password">
<title>Server Password</title>
<para>This extension retrieves and resets the encrypted
admin password set through metadata service.</para>
<para>This extension retrieves and resets the encrypted admin
password set through metadata service.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-server-password.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
@ -118,10 +120,21 @@
href="../wadls/compute-api/src/ext/os-rescue.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-instance-actions">
<title>Server Actions - List or Get Details</title>
<para>Permits all users to list available actions for a specified server. Permits administrators to get
details for a specified action for a specified server.
</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-instance-actions.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-admin-actions">
<title>Admin Actions</title>
<title>Server Actions (Admin)</title>
<para>Permits administrators to perform actions on a
server.</para>
<wadl:resources
href="../wadls/compute-api/src/ext/os-admin-actions.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>

27
api-ref/src/wadls/compute-api/src/api_samples/os-instance-actions/instance-action-get-resp.json Executable file
View File

@ -0,0 +1,27 @@
{
"instanceAction": {
"action": "reboot",
"events": [
{
"event": "schedule",
"finish_time": "2012-12-05 01:02:00.000000",
"result": "Success",
"start_time": "2012-12-05 01:00:02.000000",
"traceback": ""
},
{
"event": "compute_create",
"finish_time": "2012-12-05 01:04:00.000000",
"result": "Success",
"start_time": "2012-12-05 01:03:00.000000",
"traceback": ""
}
],
"instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
"message": "",
"project_id": "147",
"request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
"start_time": "2012-12-05 00:00:00.000000",
"user_id": "789"
}
}

12
api-ref/src/wadls/compute-api/src/api_samples/os-instance-actions/instance-action-get-resp.xml Executable file
View File

@ -0,0 +1,12 @@
<?xml version='1.0' encoding='UTF-8'?>
<instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13"
user_id="789" start_time="2012-12-05 00:00:00.000000"
request_id="req-3293a3f1-b44c-4609-b8d2-d81b105636b8"
action="reboot" message="" project_id="147">
<events finish_time="2012-12-05 01:02:00.000000"
start_time="2012-12-05 01:00:02.000000" traceback=""
event="schedule" result="Success"/>
<events finish_time="2012-12-05 01:04:00.000000"
start_time="2012-12-05 01:03:00.000000" traceback=""
event="compute_create" result="Success"/>
</instanceAction>

22
api-ref/src/wadls/compute-api/src/api_samples/os-instance-actions/instance-actions-list-resp.json Executable file
View File

@ -0,0 +1,22 @@
{
"instanceActions": [
{
"action": "resize",
"instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
"message": "",
"project_id": "842",
"request_id": "req-25517360-b757-47d3-be45-0e8d2a01b36a",
"start_time": "2012-12-05 01:00:00.000000",
"user_id": "789"
},
{
"action": "reboot",
"instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
"message": "",
"project_id": "147",
"request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
"start_time": "2012-12-05 00:00:00.000000",
"user_id": "789"
}
]
}

11
api-ref/src/wadls/compute-api/src/api_samples/os-instance-actions/instance-actions-list-resp.xml Executable file
View File

@ -0,0 +1,11 @@
<?xml version='1.0' encoding='UTF-8'?>
<instanceActions>
<instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13"
user_id="789" start_time="2012-12-05 01:00:00.000000"
request_id="req-25517360-b757-47d3-be45-0e8d2a01b36a"
action="resize" message="" project_id="842"/>
<instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13"
user_id="789" start_time="2012-12-05 00:00:00.000000"
request_id="req-3293a3f1-b44c-4609-b8d2-d81b105636b8"
action="reboot" message="" project_id="147"/>
</instanceActions>

84
api-ref/src/wadls/compute-api/src/ext/os-flavormanage.wadl.bak
View File

@ -1,84 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="flavors" path="flavors">
<method href="#createFlavor" />
<resource id="flavor" path="{flavor_id}">
<param name="flavor_id" style="template">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the flavor.
</p></doc>
</param>
<method href="#deleteFlavor" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="POST" id="createFlavor">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Create a flavor.
</p>
</wadl:doc>
<request>
<param style="plain" name="name" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a name for the new flavor you want to create</p></doc>
</param>
<param style="plain" name="ram" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a MB value for the amount of RAM for this flavor.</p></doc>
</param>
<param style="plain" name="vcpus" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a whole integer value for the virtual CPUs for the new flavor you want to create.</p></doc>
</param>
<param style="plain" name="disk" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a GB value for the amount of disk space.</p></doc>
</param>
<param style="plain" name="id" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">Enter a unique integer value for the identifier for the new flavor.</p></doc>
</param>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/os-flavormanage-request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/os-flavormanage-response.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteFlavor">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a flavor.</p>
</wadl:doc>
<response status="204" />
</method>
</application>

147
api-ref/src/wadls/compute-api/src/ext/os-floating-ip-dns.wadl.bak
View File

@ -1,147 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="os-floating-ip-dns" path="os-floating-ip-dns">
<method href="#ListDomains" />
<resource path="{domain}">
<param name="domain" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
Registered DNS Domain published by the DNS drivers.
</p></doc>
</param>
<method href="#CreateDomain" />
<method href="#DeleteDomain" />
<resource id="entries" path="entries">
<resource path="{name}">
<param name="name" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
DNS entry name assigned under a domain.
</p></doc>
</param>
<method href="#CreateEntry" />
<method href="#FindUniqueEntry" />
<method href="#DeleteEntry" />
</resource>
<resource path="{ip}">
<method href="#FindEntriesbyIP" />
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="ListDomains">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List DNS Domains">
<p xmlns="http://www.w3.org/1999/xhtml">Get a list of registered DNS Domains published by the DNS drivers.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_list_response.json" />
</doc>
</representation>
</response>
</method>
<method name="PUT" id="CreateDomain">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Create a Domain">
<p xmlns="http://www.w3.org/1999/xhtml">Create or modify a DNS domain.</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_domain_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_domain_response.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="DeleteDomain">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Delete a Domain">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a DNS domain and all associated host entries.</p>
</wadl:doc>
<response status="200" />
</method>
<method name="PUT" id="CreateEntry">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Create DNS Entry">
<p xmlns="http://www.w3.org/1999/xhtml">Create or modify a DNS entry.</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_dns_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_create_dns_response.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="FindUniqueEntry">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Find Unique DNS Entry">
<p xmlns="http://www.w3.org/1999/xhtml">Find unique DNS entry for a given domain and name.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_finduniqentry_response.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="FindEntriesbyIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Find DNS Entries">
<p xmlns="http://www.w3.org/1999/xhtml">Find DNS entries for a given domain and IP.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_dns_findentries_response.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="DeleteEntry">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Delete a DNS entry">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a DNS entry.</p>
</wadl:doc>
<response status="200" />
</method>
</application>

44
api-ref/src/wadls/compute-api/src/ext/os-floating-ip-pools.wadl.bak
View File

@ -1,44 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://floatingippools.example.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="floating-ip-pools" path="os-floating-ip-pools">
<method href="#listFloatingIpPools" />
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listFloatingIpPools">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="List Floating IP Pools">
<p xmlns="http://www.w3.org/1999/xhtml">
View a list of Floating IP Pools.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_pools_list.json" />
</doc>
</representation>
</response>
</method>
</application>

102
api-ref/src/wadls/compute-api/src/ext/os-floating-ips.wadl.bak
View File

@ -1,102 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="os-floating-ips" path="os-floating-ips">
<method href="#ListFloatingIPs" />
<method href="#AllocateFloatingIP" />
<resource path="{id}">
<param name="id" style="template" required="true">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier associated with allocated floating IP address.
</p></doc>
</param>
<method href="#DetailFloatingIP" />
<method href="#DeallocateFloatingIP" />
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="ListFloatingIPs">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List Floating IPs">
<p xmlns="http://www.w3.org/1999/xhtml">Lists floating IP addresses associated with the tenant or account.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/list_floating_ips.json" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="AllocateFloatingIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Allocate Floating IP">
<p xmlns="http://www.w3.org/1999/xhtml">Allocate a new floating IP address to a tenant or account.</p>
</wadl:doc>
<request>
<param name="pool" style="plain">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
Pool to allocate ip from. Will use default pool if not specified.
</p>
</doc>
</param>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/allocate_floating_ip_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/allocate_floating_ip_response.json" />
</doc>
</representation>
</response>
<response status="400"><doc xml:lang="EN"><p xmlns="http://www.w3.org/1999/xhtml">If there are no floating IPs available, the
extension returns an error code 400 with a message indicating that no more floating IPs are available.</p></doc></response>
</method>
<method name="GET" id="DetailFloatingIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="List Floating IP Detail">
<p xmlns="http://www.w3.org/1999/xhtml">Lists details of the floating IP address associated with floating_IP_address_ID.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/floating_ip_detail.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="DeallocateFloatingIP">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN" title="Deallocate Floating IP">
<p xmlns="http://www.w3.org/1999/xhtml">Deallocates the floating IP address associated with floating_IP_address_ID.</p>
</wadl:doc>
<response status="202" />
</method>
</application>

117
api-ref/src/wadls/compute-api/src/ext/os-instance-actions.wadl Normal file
View File

@ -0,0 +1,117 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
%common;]>
<!-- (C) 2013 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:atom="http://www.w3.org/2005/Atom">
<grammars>
<include href="xsd/api.xsd"/>
<include href="xsd/api-common.xsd"/>
</grammars>
<resources base="https://servers.api.openstack.com">
<resource id="version" type="#VersionDetails" path="v2/">
<resource id="tenantID" path="{tenant_id}">
<param name="tenant_id" style="template"
type="xsd:string">
<doc><p xmlns="http://www.w3.org/1999/xhtml">The
ID for the tenant or account in a
multi-tenancy cloud. </p></doc>
</param>
<resource id="Servers" path="servers">
<resource path="{server_id}">
<param name="server_id" style="template"
type="csapi:UUID">
<doc><p
xmlns="http://www.w3.org/1999/xhtml"
>The UUID of the server instance
for which you want to list actions.
</p>
</doc>
</param>
<resource path="os-instance-actions">
<method href="#listActions"/>
<resource path="{action_id}">
<param name="action_id"
style="template" type="csapi:UUID">
<doc xml:lang="EN"
title="Get Action Details">
<p
xmlns="http://www.w3.org/1999/xhtml"
>The UUID of the action for which
you want to get details. </p>
</doc>
</param>
<method href="#getActionDetails"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listActions">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN"
title="Get Server Actions">
<p xmlns="http://www.w3.org/1999/xhtml">Lists available actions
for a specified server. Deployers set permissions for this request in the
<filename>policy.json</filename> file. By default, all users
can list actions. </p>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-actions-list-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-actions-list-resp.xml"
/>
</doc>
</representation>
</response>
</method>
<method name="GET" id="getActionDetails">
<wadl:doc xml:lang="EN" title="Get Action Details"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Gets details for a specified action
for a specified server instance. Deployers set permissions for this request in the
<filename>policy.json</filename> file. By default, only administrators can get details for an action.
</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-action-get-resp.json"
/>
</doc>
</representation>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code
href="../api_samples/os-instance-actions/instance-action-get-resp.xml"
/>
</doc>
</representation>
</response>
<!-- Common Faults and GET Faults--> &commonFaults;
&getFaults; </method>
</application>

204
api-ref/src/wadls/compute-api/src/ext/os-security-groups.wadl.bak
View File

@ -1,204 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012 OpenStack LLC., All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<resources base="https://servers.api.openstack.com/">
<resource id="version" path="v1.1">
<resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the tenant or account.
</p>
</doc>
</param>
<resource id="security_groups" path="os-security-groups">
<method href="#listSecGroups" />
<method href="#createSecGroup" />
<resource id="get_security_group" path="{security_group_id}">
<param name="security_group_id" style="template">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the security group.
</p></doc>
</param>
<method href="#getSecGroup" />
<method href="#deleteSecGroup" />
</resource>
</resource>
<resource id="security_groups" path="os-security-group-rules">
<method href="#createSecGroupRule" />
<resource path="{security_group_rule_id}">
<param name="security_group_rule_id" style="template">
<doc><p xmlns="http://www.w3.org/1999/xhtml">
The unique identifier of the security group rule.
</p></doc>
</param>
<method href="#deleteSecGroupRule" />
</resource>
</resource>
<resource id="Servers" path="servers">
<resource path="{server_id}">
<param name="server_id" style="template" type="csapi:UUID">
<doc>
<p xmlns="http://www.w3.org/1999/xhtml">
The UUID for the server of interest to you.
</p>
</doc>
</param>
<resource path="os-security-groups">
<method href="#listSecGroupsByServer"/>
</resource>
</resource>
</resource>
</resource>
</resource>
</resources>
<method name="GET" id="listSecGroups">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">List security groups.</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="listSecGroupsByServer">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
List security groups for a specific server.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_groups_list.json" />
</doc>
</representation>
</response>
</method>
<method name="GET" id="getSecGroup">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Get specific security group.
</p>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_get.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_get.json" />
</doc>
</representation>
</response>
</method>
<method name="POST" id="createSecGroup">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Create a new security group.
</p>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create_request.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_create.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroup">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">Delete a security group.</p>
</wadl:doc>
<response status="202" />
</method>
<method name="POST" id="createSecGroupRule">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Create security group rule.
</p>
</wadl:doc>
<request>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_rule_create_request.json" />
</doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_rule_create.xml" />
</doc>
</representation>
<representation mediaType="application/json">
<doc xml:lang="EN">
<xsdxt:code href="samples/security_group_rule_create.json" />
</doc>
</representation>
</response>
</method>
<method name="DELETE" id="deleteSecGroupRule">
<wadl:doc xmlns="http://www.w3.org/1999/xhtml" xml:lang="EN">
<p xmlns="http://www.w3.org/1999/xhtml">
Delete security group rule.
</p>
</wadl:doc>
<response status="202" />
</method>
</application>