openstack/api-site
Code Issues Proposed changes

Updates documentation for lbaas-api-and-objmodel-improvement

Browse Source 
(https://review.openstack.org/#/c/89903/1)
Adds/updates code samples for Neutron LBaas API v2.0
Fixed formatting in JSON code samples
Updated os-lbaas-ext.wadl file
Updated method names to be more meaningful
Delete the unused file:os-lbaas-ext-origional.wadl
Listener parameters seem to be added properly
Removed unused code samples

Closes-Bug: #1331525

Change-Id: I584d29b47e0d528e146eca3e477e14940377c61f
This commit is contained in:
minwang
2014-07-09 17:13:36 -07:00
committed by Diane Fleming
parent 113f501aa5
commit 495f706985
46 changed files with 846 additions and 883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
api-ref/src/docbkx/ch_netconn-ext-v2.xml
View File

@@ -1,34 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref" xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="netconn-v2-ext">
<title>Networking API v2.0 extensions</title>
<section xml:id="neutron_extensions">
<title>Extensions</title>
<para>List available Networking API v2.0 extensions and show
details for a specified extension.</para>
<para>List available Networking API v2.0 extensions and show details for a specified
extension.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#extensions">
<wadl:resource href="../wadls/netconn-api/src/os-networks.wadl#extensions">
<wadl:method href="#listExtensions"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#extension">
<wadl:resource href="../wadls/netconn-api/src/os-networks.wadl#extension">
<wadl:method href="#getExtension"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="quotas-ext">
<title>Quotas extension (quotas)</title>
<para>List, show information for, update, and reset
quotas.</para>
<para>List, show information for, update, and reset quotas.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-quotas.wadl#Quotas">
<wadl:resource href="../wadls/netconn-api/src/os-quotas.wadl#Quotas">
<wadl:method href="#listQuotas"/>
<wadl:method href="#showQuota"/>
<wadl:method href="#updateQuota"/>
@@ -37,16 +30,13 @@
</wadl:resources>
</section>
<section xml:id="network_provider-ext">
<title>Networks provider extended attributes
(networks)</title>
<title>Networks provider extended attributes (networks)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#Networks">
<wadl:resource href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#Networks">
<wadl:method href="#listNetworks"/>
<wadl:method href="#createNetwork"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#network_id">
<wadl:resource href="../wadls/netconn-api/src/os-networks-provider-ext.wadl#network_id">
<wadl:method href="#showNetwork"/>
<wadl:method href="#updateNetwork"/>
<wadl:method href="#deleteNetwork"/>
@@ -55,44 +45,37 @@
</section>
<section xml:id="network_multi_provider-ext">
<title>Networks multiple provider extension (networks)</title>
<para>Enables administrative users to define multiple physical
bindings for an OpenStack Networking network and list or
show details for networks with multiple physical
<para>Enables administrative users to define multiple physical bindings for an OpenStack
Networking network and list or show details for networks with multiple physical
bindings.</para>
<para>You cannot update any <literal>provider</literal>
attributes. If you try to do so, an 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 <literal>segments</literal> list in the request
body of a <code>POST /v2.0/networks</code> request. Each
element in the <literal>segments</literal> list has the
same structure as the provider network attributes. These
attributes are <literal>provider:network_type</literal>,
<para>You cannot update any <literal>provider</literal> attributes. If you try to do so, an
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
<literal>segments</literal> list in the request body of a <code>POST
/v2.0/networks</code> request. Each element in the <literal>segments</literal> list
has the same structure as the provider network attributes. These attributes are
<literal>provider:network_type</literal>,
<literal>provider:physical_network</literal>, and
<literal>provider:segmentation_id</literal>. The
validation rules for these attributes are the same as for
the <link
<literal>provider:segmentation_id</literal>. The validation rules for these
attributes are the same as for the <link
xlink:href="http://developer.openstack.org/api-ref-networking.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>
<wadl:resources
href="../wadls/netconn-api/src/os-networks-multi-provider-ext.wadl"
>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>
<wadl:resources href="../wadls/netconn-api/src/os-networks-multi-provider-ext.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="port_binding-ext">
<title>Ports binding extended attributes (ports)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-ports-binding-ext.wadl#Ports">
<wadl:resource href="../wadls/netconn-api/src/os-ports-binding-ext.wadl#Ports">
<wadl:method href="#listPorts"/>
<wadl:method href="#createPort"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/os-ports-binding-ext.wadl#port_id">
<wadl:resource href="../wadls/netconn-api/src/os-ports-binding-ext.wadl#port_id">
<wadl:method href="#showPort"/>
<wadl:method href="#updatePort"/>
</wadl:resource>
@@ -101,13 +84,11 @@
<section xml:id="security_groups">
<title>Security groups and rules (security-groups)</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/security-groups.wadl#security_groups">
<wadl:resource href="../wadls/netconn-api/src/security-groups.wadl#security_groups">
<wadl:method href="#listSecGroups"/>
<wadl:method href="#createSecGroup"/>
</wadl:resource>
<wadl:resource
href="../wadls/netconn-api/src/security-groups.wadl#security_group_id">
<wadl:resource href="../wadls/netconn-api/src/security-groups.wadl#security_group_id">
<wadl:method href="#getSecGroup"/>
<wadl:method href="#deleteSecGroup"/>
</wadl:resource>
@@ -125,49 +106,37 @@
</section>
<section xml:id="layer3">
<title>Layer-3 networking</title>
<para>Route packets between subnets, forward packets from
internal networks to external ones, and access instances
from external networks through floating IPs.</para>
<para>Route packets between subnets, forward packets from internal networks to external
ones, and access instances from external networks through floating IPs.</para>
<para>This extension introduces these resources:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">router</emphasis>. A
logical entity for forwarding packets across
internal subnets and NATting them on external
networks through an appropriate external
gateway.</para>
<para><emphasis role="bold">router</emphasis>. A logical entity for forwarding
packets across internal subnets and NATting them on external networks through an
appropriate external gateway.</para>
</listitem>
<listitem>
<para><emphasis role="bold">floatingip</emphasis>. An
external IP address that is mapped to a port that
is attached to an internal network.</para>
<para><emphasis role="bold">floatingip</emphasis>. An external IP address that is
mapped to a port that is attached to an internal network.</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/netconn-api/src/os-layer3-ext.wadl"
> </wadl:resources>
href="../wadls/netconn-api/src/os-layer3-ext.wadl"/>
</section>
<section status="final" xml:id="metering-ext"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<section status="final" xml:id="metering-ext" xmlns:wadl="http://wadl.dev.java.net/2009/02">
<title>Metering labels and rules</title>
<para>Create, modify, and delete OpenStack Layer3 Metering
labels and rules.</para>
<para>Create, modify, and delete OpenStack Layer3 Metering labels and rules.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/netconn-api/src/metering-labels.wadl"
> </wadl:resources>
href="../wadls/netconn-api/src/metering-labels.wadl"/>
</section>
<section xml:id="lbaas">
<title>Load-Balancer-as-a-Service (LBaaS)</title>
<para>The LBaaS extension enables OpenStack tenants to
load-balance their VM traffic. The extension enables you
to load-balance client traffic from one network to
application services, such as VMs, on the same or a
different network. You can load-balance several protocols,
such as TCP and HTTP and monitor the health of application
services. The LBaaS extension supports session
persistence.</para>
<para>The LBaaS extension enables OpenStack tenants to load-balance their VM traffic. The
extension enables you to load-balance client traffic from one network to application
services, such as VMs, on the same or a different network. You can load-balance several
protocols, such as TCP and HTTP and monitor the health of application services. The
LBaaS extension supports session persistence.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/netconn-api/src/os-lbaas-ext.wadl"
> </wadl:resources>
href="../wadls/netconn-api/src/os-lbaas-ext.wadl"/>
</section>
</chapter>

3
api-ref/src/docbkx/ch_netconn-v2.xml
View File

@@ -18,8 +18,7 @@
available IP address.</para>
<section xml:id="neutron-versions-v2">
<title>API versions</title>
<para>List information for all Networking API versions and show details
about API v2.</para>
<para>List information for all Networking API versions and show details about API v2.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/netconn-api/src/os-networks.wadl#versions">

25
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-get-detail-resp.json
View File

@@ -1,14 +1,15 @@
{
"health_monitor": {
"admin_state_up": true,
"tenant_id": "83657cfcdfe44cd5920adaf26c48ceea",
"delay": 5,
"expected_codes": "200",
"max_retries": 2,
"http_method": "GET",
"timeout": 2,
"url_path": "/",
"type": "HTTP",
"id": "5d4b5228-33b0-4e60-b225-9b727c1a20e7"
}
"healthmonitor":{
"id":"f3eeab00-8367-4524-b662-55e64d4cacb5",
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"type":"HTTP",
"delay":20,
"timeout":10,
"max_retries":5,
"http_method":"GET",
"url_path":"/check",
"expected_codes":"200-299",
"admin_state_up":true,
"status":"ACTIVE"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-post-associate-req.json
View File

@@ -1,5 +0,0 @@
{
"health_monitor": {
"id": "b624decf-d5d3-4c66-9a3d-f047e7786181"
}
}

3
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-post-associate-resp.json
View File

@@ -1,3 +0,0 @@
{
"health_monitor": {}
}

16
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-post-req.json
View File

@@ -1,9 +1,11 @@
{
"health_monitor": {
"delay": "1",
"max_retries": "1",
"type": "HTTP",
"timeout": "1",
"admin_state_up": true
}
"healthmonitor":{
"type":"HTTP",
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"delay":20,
"timeout":10,
"max_retries":5,
"url_path":"/check",
"expected_codes":"200-299"
}
}

26
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-post-resp.json
View File

@@ -1,15 +1,15 @@
{
"health_monitor": {
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"delay": 1,
"expected_codes": "200",
"max_retries": 1,
"http_method": "GET",
"timeout": 1,
"pools": [],
"url_path": "/",
"type": "HTTP",
"id": "b624decf-d5d3-4c66-9a3d-f047e7786181"
}
"healthmonitor":{
"id":"f3eeab00-8367-4524-b662-55e64d4cacb5",
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"type":"HTTP",
"delay":20,
"timeout":10,
"max_retries":5,
"http_method":"GET",
"url_path":"/check",
"expected_codes":"200-299",
"admin_state_up":true,
"status":"ACTIVE"
}
}

15
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-put-update-resp.json
View File

@@ -1,15 +0,0 @@
{
"health_monitor": {
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"delay": 3,
"expected_codes": "200",
"max_retries": 1,
"http_method": "GET",
"timeout": 1,
"pools": [],
"url_path": "/",
"type": "HTTP",
"id": "b624decf-d5d3-4c66-9a3d-f047e7786181"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/HealthMonitor-put-update.req.json
View File

@@ -1,5 +0,0 @@
{
"health_monitor": {
"delay": "3"
}
}

21
api-ref/src/wadls/netconn-api/src/api_samples/Member-get-detail-resp.json
View File

@@ -1,13 +1,12 @@
{
"member": {
"status": "PENDING_CREATE",
"protocol_port": 8080,
"weight": 1,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"pool_id": "7803631d-f181-4500-b3a2-1b68ba2a75fd",
"address": "10.0.0.5",
"status_description": null,
"id": "48a471ea-64f1-4eb6-9be7-dae6bbe40a0f"
}
"member":{
"id":"975592ca-e308-48ad-8298-731935ee9f45",
"address":"192.0.2.14",
"protocol_port":8080,
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"admin_state_up":true,
"weight":1,
"subnet_id":"SUBNET_ID",
"status":"DOWN"
}
}

12
api-ref/src/wadls/netconn-api/src/api_samples/Member-post-req.json
View File

@@ -1,8 +1,8 @@
{
"member": {
"protocol_port": "8080",
"address": "10.0.0.5",
"pool_id": "7803631d-f181-4500-b3a2-1b68ba2a75fd",
"admin_state_up": true
}
"member": {
"tenant_id": "453105b9-1754-413f-aab1-55f1af620750",
"address": "192.0.2.14",
"protocol_port":8080,
"subnet_id": "SUBNET_ID"
}
}

21
api-ref/src/wadls/netconn-api/src/api_samples/Member-post-resp.json
View File

@@ -1,13 +1,12 @@
{
"member": {
"status": "PENDING_CREATE",
"protocol_port": 8080,
"weight": 1,
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"pool_id": "7803631d-f181-4500-b3a2-1b68ba2a75fd",
"address": "10.0.0.5",
"status_description": null,
"id": "48a471ea-64f1-4eb6-9be7-dae6bbe40a0f"
}
"member": {
"id": "975592ca-e308-48ad-8298-731935ee9f45",
"address": "192.0.2.14",
"protocol_port": 8080,
"tenant_id": "453105b9-1754-413f-aab1-55f1af620750",
"admin_state_up":true,
"weight": 1,
"subnet_id": "SUBNET_ID",
"status": "DOWN"
}
}

13
api-ref/src/wadls/netconn-api/src/api_samples/Member-put-update-resp.json
View File

@@ -1,13 +0,0 @@
{
"member": {
"status": "PENDING_UPDATE",
"protocol_port": 8080,
"weight": 1,
"admin_state_up": false,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"pool_id": "7803631d-f181-4500-b3a2-1b68ba2a75fd",
"address": "10.0.0.5",
"status_description": null,
"id": "48a471ea-64f1-4eb6-9be7-dae6bbe40a0f"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/Member-put-update.req.json
View File

@@ -1,5 +0,0 @@
{
"member": {
"admin_state_up": false
}
}

19
api-ref/src/wadls/netconn-api/src/api_samples/Pool-put-update-resp.json
View File

@@ -1,19 +0,0 @@
{
"pool": {
"status": "PENDING_UPDATE",
"lb_method": "ROUND_ROBIN",
"protocol": "HTTP",
"description": "",
"health_monitors": [],
"subnet_id": "b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id": "5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up": true,
"name": "my-updated-pool",
"health_monitors_status": [],
"members": [],
"provider": "haproxy",
"status_description": null,
"id": "e019fadf-5083-40ad-9480-4553343995b6",
"vip_id": null
}
}

0
api-ref/src/wadls/netconn-api/src/api_samples/hms-get-resp.json → api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-get-resp.json
View File

15
api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-list-resp.json Normal file
View File

@@ -0,0 +1,15 @@
{
"healthmonitors":{
"id":"f3eeab00-8367-4524-b662-55e64d4cacb5",
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"type":"HTTP",
"delay":20,
"timeout":10,
"max_retries":5,
"http_method":"GET",
"url_path":"/check",
"expected_codes":"200-299",
"admin_state_up":true,
"status":"ACTIVE"
}
}

6
api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-req.json Normal file
View File

@@ -0,0 +1,6 @@
{
"healthmonitor":{
"path":"/healthcheck",
"delay":3
}
}

15
api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-resp.json Normal file
View File

@@ -0,0 +1,15 @@
{
"healthmonitor":{
"id":"f3eeab00-8367-4524-b662-55e64d4cacb5",
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"type":"HTTP",
"delay":3,
"timeout":10,
"max_retries":5,
"http_method":"GET",
"url_path":"/healthcheck",
"expected_codes":"200-299",
"admin_state_up":true,
"status":"ACTIVE"
}
}

14
api-ref/src/wadls/netconn-api/src/api_samples/listener-get-detail-resp.json Normal file
View File

@@ -0,0 +1,14 @@
{
"listener":{
"id":"9bb09b2b-a0e3-4fa7-8020-76efd4b30d30",
"default_pool_id":"8311446e-8a13-4c00-95b3-03a92f9759c7",
"tenant_id":"352686b7-c4b2-44ec-a458-84239713f685",
"name":"Example HTTPS Listener",
"description":"A very simple example of an HTTPS listener",
"protocol":"https",
"protocol_port":"443",
"load_balancer_id":"b8a35470-f65d-11e3-a3ac-0800200c9a66",
"admin_state_up":true,
"status":"ACTIVE"
}
}

26
api-ref/src/wadls/netconn-api/src/api_samples/listener-list-resp.json Normal file
View File

@@ -0,0 +1,26 @@
{
"listeners":[
{
"id":"fddd4b15-faca-4a60-af4c-43317b9ad363",
"tenant_id":"783b31af-6635-48b2-a807-091d9973e3a9",
"name":"Example HTTPS Listener",
"description":"A very simple example of an HTTPS listener.",
"protocol":"https",
"protocol_port":"443",
"load_balancer_id":"b8a35470-f65d-11e3-a3ac-0800200c9a66",
"admin_state_up":true,
"status":"ACTIVE"
},
{
"id":"9341aafc-7e7d-4807-8199-9e81dadd0577",
"tenant_id":"783b31af-6635-48b2-a807-091d9973e3a9",
"name":"Example HTTPS Listener",
"description":"A very simple example of an HTTPS listener.",
"protocol":"https",
"protocol_port":"443",
"load_balancer_id":"b8a35470-f65d-11e3-a3ac-0800200c9a66",
"admin_state_up":true,
"status":"ACTIVE"
}
]
}

12
api-ref/src/wadls/netconn-api/src/api_samples/listener-post-req.json Normal file
View File

@@ -0,0 +1,12 @@
{
"listener":{
"default_pool_id":"8311446e-8a13-4c00-95b3-03a92f9759c7",
"name":"Example HTTPS Listener",
"description":"A very simple example of an HTTPS listener.",
"tenant_id":"352686b7-c4b2-44ec-a458-84239713f685",
"connection_limit":200,
"protocol":"https",
"protocol_port":"443",
"load_balancer_id":"b8a35470-f65d-11e3-a3ac-0800200c9a66"
}
}

14
api-ref/src/wadls/netconn-api/src/api_samples/listener-post-resp.json Normal file
View File

@@ -0,0 +1,14 @@
{
"listener":{
"id":"9bb09b2b-a0e3-4fa7-8020-76efd4b30d30",
"default_pool_id":"8311446e-8a13-4c00-95b3-03a92f9759c7",
"tenant_id":"352686b7-c4b2-44ec-a458-84239713f685",
"name":"Example HTTPS Listener",
"description":"A very simple example of an HTTPS listener",
"protocol":"https",
"protocol_port":"443",
"load_balancer_id":"b8a35470-f65d-11e3-a3ac-0800200c9a66",
"admin_state_up":true,
"status":"ACTIVE"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/listener-put-req.json Normal file
View File

@@ -0,0 +1,5 @@
{
"listener":{
"name":"A New Example HTTPS Listener"
}
}

14
api-ref/src/wadls/netconn-api/src/api_samples/listener-put-resp.json Normal file
View File

@@ -0,0 +1,14 @@
{
"listener":{
"id":"9bb09b2b-a0e3-4fa7-8020-76efd4b30d30",
"default_pool_id":"8311446e-8a13-4c00-95b3-03a92f9759c7",
"tenant_id":"352686b7-c4b2-44ec-a458-84239713f685",
"name":"A New Example HTTPS Listener",
"description":"A very simple example of an HTTPS listener.",
"protocol":"https",
"protocol_port":"443",
"load_balancer_id":"b8a35470-f65d-11e3-a3ac-0800200c9a66",
"admin_state_up":true,
"status":"ACTIVE"
}
}

8
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-delete-resp.json Executable file
View File

@@ -0,0 +1,8 @@
{
"loadbalancer":{
"active_connections":0,
"total_connections":0,
"bytes_in":0,
"bytes_out":0
}
}

12
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-get-detail-resp.json Executable file
View File

@@ -0,0 +1,12 @@
{
"loadbalancer":{
"id":"8992a43f-83af-4b49-9afd-c2bfbd82d7d7",
"name":"Example LB",
"description":"A very simple example load balancer.",
"vip_address":"1.2.3.4",
"vip_subnet_id":"SUBNET_ID",
"tenant_id":"7725fe12-1c14-4f45-ba8e-44bf01763578",
"admin_state_up":true,
"status":"ACTIVE"
}
}

10
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-list-resp.json Normal file
View File

@@ -0,0 +1,10 @@
{
"loadbalancers":{
"id":"3b98602c-3cfe-4f91-bfa4-c3a11c9e7fe0",
"name":"Example LB",
"description":"A very simple example load balancer.",
"tenant_id":"783b31af-6635-48b2-a807-091d9973e3a9",
"admin_state_up":true,
"status":"ACTIVE"
}
}

8
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-req.json Executable file
View File

@@ -0,0 +1,8 @@
{
"loadbalancer":{
"name":"Example LB",
"description":"A very simple example load balancer.",
"vip_subnet":"SUBNET_ID",
"tenant_id":"7725fe12-1c14-4f45-ba8e-44bf01763578"
}
}

11
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-resp.json Executable file
View File

@@ -0,0 +1,11 @@
{
"loadbalancer":{
"id":"8992a43f-83af-4b49-9afd-c2bfbd82d7d7",
"name":"Example LB",
"description":"A very simple example load balancer.",
"vip_address":"1.2.3.4",
"vip_subnet_id":"SUBNET_ID",
"tenant_id":"7725fe12-1c14-4f45-ba8e-44bf01763578",
"status":"PENDING_CREATE"
}
}

6
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-put-req.json Executable file
View File

@@ -0,0 +1,6 @@
{
"loadbalancer":{
"name":"A New Example LB",
"description":"A new very simple example load balancer."
}
}

12
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-put-resp.json Executable file
View File

@@ -0,0 +1,12 @@
{
"loadbalancer":{
"id":"8992a43f-83af-4b49-9afd-c2bfbd82d7d7",
"name":"A New Example LB",
"description":"A new very simple example load balancer.",
"vip_address":"1.2.3.4",
"vip_subnet_id":"SUBNET_ID",
"tenant_id":"7725fe12-1c14-4f45-ba8e-44bf01763578",
"admin_state_up":true,
"status":"ACTIVE"
}
}

24
api-ref/src/wadls/netconn-api/src/api_samples/member-get-resp.json
View File

@@ -1,24 +0,0 @@
{
"members": [
{
"status": "ACTIVE",
"weight": 1,
"admin_state_up": true,
"tenant_id": "83657cfcdfe44cd5920adaf26c48ceea",
"pool_id": "72741b06-df4d-4715-b142-276b6bce75ab",
"address": "10.0.0.4",
"protocol_port": 80,
"id": "701b531b-111a-4f21-ad85-4795b7b12af6"
},
{
"status": "ACTIVE",
"weight": 1,
"admin_state_up": true,
"tenant_id": "83657cfcdfe44cd5920adaf26c48ceea",
"pool_id": "72741b06-df4d-4715-b142-276b6bce75ab",
"address": "10.0.0.3",
"protocol_port": 80,
"id": "beb53b4d-230b-4abd-8118-575b8fa006ef"
}
]
}

12
api-ref/src/wadls/netconn-api/src/api_samples/member-list-resp.json Normal file
View File

@@ -0,0 +1,12 @@
{
"members":{
"id":"975592ca-e308-48ad-8298-731935ee9f45",
"address":"192.0.2.14",
"protocol_port":8080,
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"admin_state_up":true,
"weight":1,
"subnet_id":"SUBNET_ID",
"status":"DOWN"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/member-put-req.json Normal file
View File

@@ -0,0 +1,5 @@
{
"member":{
"admin_state_up":false
}
}

12
api-ref/src/wadls/netconn-api/src/api_samples/member-put-resp.json Normal file
View File

@@ -0,0 +1,12 @@
{
"member":{
"id":"975592ca-e308-48ad-8298-731935ee9f45",
"address":"192.0.2.14",
"protocol_port":8080,
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750",
"admin_state_up":false,
"weight":1,
"subnet_id":"SUBNET_ID",
"status":"DOWN"
}
}

32
api-ref/src/wadls/netconn-api/src/api_samples/pool-get-detail-resp.json
View File

@@ -1,19 +1,17 @@
{
"pool": {
"status": "ACTIVE",
"lb_method": "ROUND_ROBIN",
"protocol": "HTTP",
"description": "",
"health_monitors": [],
"subnet_id": "b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id": "5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up": true,
"name": "my-pool",
"health_monitors_status": [],
"members": [],
"provider": "haproxy",
"status_description": null,
"id": "e019fadf-5083-40ad-9480-4553343995b6",
"vip_id": null
}
"pool":{
"id":"332abe93-f488-41ba-870b-2ac66be7f853",
"tenant_id":"19eaa775-cf5d-49bc-902e-2f85f668d995",
"name":"Example pool",
"description":"",
"protocol":"tcp",
"lb_algorithm":"ROUND_ROBIN",
"session_persistence":{
},
"healthmonitor_id":null,
"members":[
],
"admin_state_up":true,
"status":"ACTIVE"
}
}

34
api-ref/src/wadls/netconn-api/src/api_samples/pool-list-resp.json Normal file
View File

@@ -0,0 +1,34 @@
{
"pools":[
{
"id":"332abe93-f488-41ba-870b-2ac66be7f853",
"tenant_id":"19eaa775-cf5d-49bc-902e-2f85f668d995",
"name":"Example pool",
"description":"",
"protocol":"tcp",
"lb_algorithm":"ROUND_ROBIN",
"session_persistence":{
},
"healthmonitor_id":null,
"members":[
],
"admin_state_up":true,
"status":"ACTIVE"
},
{
"id":"332abe93-f488-41ba-870b-2ac66be7f854",
"tenant_id":"19eaa775-cf5d-49bc-902e-2f85f668d995",
"name":"Example pool",
"description":"",
"protocol":"tcp",
"lb_algorithm":"ROUND_ROBIN",
"session_persistence":{
},
"healthmonitor_id":null,
"members":[
],
"admin_state_up":true,
"status":"ACTIVE"
}
]
}

13
api-ref/src/wadls/netconn-api/src/api_samples/pool-post-req.json
View File

@@ -1,9 +1,8 @@
{
"pool": {
"subnet_id": "8032909d-47a1-4715-90af-5153ffe39861",
"lb_method": "ROUND_ROBIN",
"protocol": "TCP",
"name": "NewPool",
"admin_state_up": true
}
"pool":{
"name":"Example pool",
"tenant_id":"19eaa775-cf5d-49bc-902e-2f85f668d995",
"protocol":"HTTP",
"lb_algorithm":"ROUND_ROBIN"
}
}

32
api-ref/src/wadls/netconn-api/src/api_samples/pool-post-resp.json
View File

@@ -1,19 +1,17 @@
{
"pool": {
"status": "PENDING_CREATE",
"lb_method": "ROUND_ROBIN",
"protocol": "HTTP",
"description": "",
"health_monitors": [],
"subnet_id": "b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id": "5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up": true,
"name": "my-pool",
"health_monitors_status": [],
"members": [],
"provider": "haproxy",
"status_description": null,
"id": "e019fadf-5083-40ad-9480-4553343995b6",
"vip_id": null
}
"pool":{
"id":"332abe93-f488-41ba-870b-2ac66be7f853",
"tenant_id":"19eaa775-cf5d-49bc-902e-2f85f668d995",
"name":"Example pool",
"description":"",
"protocol":"tcp",
"lb_algorithm":"ROUND_ROBIN",
"session_persistence":{
},
"healthmonitor_id":null,
"members":[
],
"admin_state_up":true,
"status":"ACTIVE"
}
}

6
api-ref/src/wadls/netconn-api/src/api_samples/pool-put-req.json Normal file
View File

@@ -0,0 +1,6 @@
{
"pool":{
"lb_algorithm":"LEAST_CONNECTIONS",
"name":"New pool name"
}
}

17
api-ref/src/wadls/netconn-api/src/api_samples/pool-put-resp.json Normal file
View File

@@ -0,0 +1,17 @@
{
"pool":{
"id":"332abe93-f488-41ba-870b-2ac66be7f853",
"tenant_id":"19eaa775-cf5d-49bc-902e-2f85f668d995",
"name":"New pool name",
"description":"",
"protocol":"tcp",
"lb_algorithm":"LEAST_CONNECTIONS",
"session_persistence":{
},
"healthmonitor_id":null,
"members":[
],
"admin_state_up":true,
"status":"ACTIVE"
}
}

5
api-ref/src/wadls/netconn-api/src/api_samples/pool-put-update.req.json
View File

@@ -1,5 +0,0 @@
{
"pool": {
"name": "my-updated-pool"
}
}

21
api-ref/src/wadls/netconn-api/src/api_samples/pools-get-resp.json
View File

@@ -1,21 +0,0 @@
{
"pools": [
{
"status": "ACTIVE",
"lb_method": "ROUND_ROBIN",
"protocol": "HTTP",
"description": "",
"health_monitors": [],
"subnet_id": "b338d9c6-beec-4404-8e1a-b608c324a8ad",
"tenant_id": "5ef70662f8b34079a6eddb8da9d75fe8",
"admin_state_up": true,
"name": "my-pool",
"health_monitors_status": [],
"members": [],
"provider": "haproxy",
"status_description": null,
"id": "e019fadf-5083-40ad-9480-4553343995b6",
"vip_id": null
}
]
}

278
api-ref/src/wadls/netconn-api/src/common.ent
View File

@@ -817,21 +817,31 @@
IP.</para>
</wadl:doc>
</param>'>
<!ENTITY vipResponseParams '
<!ENTITY lbLoadbalancersParam '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="loadbalancers" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>loadbalancers</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY lbLoadbalancerParam '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="loadbalancer" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>loadbalancer</code> object.</para>
</wadl:doc>
</param>'>
<!ENTITY lbResponseParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The unique ID for the VIP.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Owner of the VIP. Only an administrative user can specify a tenant ID other than its own.</para>
<para>The unique ID for the load balancer.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@@ -839,7 +849,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable name for the VIP. Does not have to be unique.</para>
<para>Load balancer name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@@ -847,19 +857,11 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable description for the VIP.</para>
<para>Load balancer description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="subnet_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the subnet on which to allocate the VIP address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="address" style="plain" type="xsd:ip">
name="vip_address" style="plain" type="xsd:ip">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
@@ -867,66 +869,20 @@
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol" style="plain" type="xsd:string">
name="vip_subnet_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The protocol of the VIP address, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol_port" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The port on which to listen to client traffic that is associated with the VIP address, which is from 0 to 65535.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="pool_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the pool with which the VIP is associated.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="session_persistence" style="plain" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Session persistence parameters for the VIP. Absence of
session_persistence attribute means no session persistence
mechanism is used. When no session persistence is used,
the session_persistence attribute does not appear in the
API response, instead of returning null. You can clear
session persistence for the VIP by sending null in
session_persistence attribute in a VIP update
request.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="connection_limit" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The maximum number of connections allowed for the VIP.
Value is <code>-1</code> if the limit is not set.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the VIP, which is up (<code>true</code>) or down (<code>false</code>).</para>
<para>The ID of the subnet on which to allocate the VIP address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="status" style="plain" 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 status of the VIP. Indicates whether the VIP is operational.</para>
<para>The status of the load balancer. Indicates whether the load balancer is operational.</para>
</wadl:doc>
</param>' >
<!ENTITY vipCreateRequestParams '
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@@ -934,13 +890,14 @@
xml:lang="EN">
<para>Owner of the VIP. Only an administrative user can specify a tenant ID other than its own.</para>
</wadl:doc>
</param>
</param>' >
<!ENTITY lbCreateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable name for the VIP. Does not have to be unique.</para>
<para>Load balancer name. Does not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@@ -948,85 +905,32 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable description for the VIP.</para>
<para>Load balancer description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="subnet_id" style="plain" type="csapi:uuid">
name="vip_subnet" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the subnet on which to allocate the VIP address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="address" style="plain" type="xsd:ip">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The IP address of the VIP.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol" style="plain" type="xsd:string">
name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The protocol of the VIP address, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol_port" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The port on which to listen to client traffic that is associated with the VIP address, which is from 0 to 65535.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="pool_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the pool with which the VIP is associated.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="session_persistence" style="plain" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Session persistence parameters for the VIP. Absence of
session_persistence attribute means no session persistence
mechanism is used. When no session persistence is used,
the session_persistence attribute does not appear in the
API response, instead of returning null. You can clear
session persistence for the VIP by sending null in
session_persistence attribute in a VIP update
request.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="connection_limit" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The maximum number of connections allowed for the VIP.
Value is <code>-1</code> if the limit is not set.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the VIP, which is up (<code>true</code>) or down (<code>false</code>).</para>
<para>Owner of the load balancer. Only an administrative user can specify a tenant ID other than its own.</para>
</wadl:doc>
</param>' >
<!ENTITY vipUpdateRequestParams '
<!ENTITY lbUpdateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="name" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable name for the VIP. Does not have to be unique.</para>
<para>Load balancer name. Does not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@@ -1034,44 +938,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Human readable description for the VIP.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="pool_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID of the pool with which the VIP is associated.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="session_persistence" style="plain" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Session persistence parameters for the VIP. Absence of
session_persistence attribute means no session persistence
mechanism is used. When no session persistence is used,
the session_persistence attribute does not appear in the
API response, instead of returning null. You can clear
session persistence for the VIP by sending null in
session_persistence attribute in a VIP update
request.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="connection_limit" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The maximum number of connections allowed for the VIP.
Value is <code>-1</code> if the limit is not set.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the VIP, which is up (<code>true</code>) or down (<code>false</code>).</para>
<para>Load balancer description.</para>
</wadl:doc>
</param>' >
<!-- pools -->
@@ -1306,6 +1173,77 @@
<para>The administrative state of the pool, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc>
</param>' >
<!ENTITY listenerRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="listener" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>listener</code> object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="default_pool_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the default pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="name" style="plain" 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 listener name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="description" style="plain" 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 listener description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Owner of the listener. Only an administrative user can specify a tenant ID other than its own.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="connection_limit" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The connection limit.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol" style="plain" 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 protocol of the listener, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="protocol_port" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The port.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="load_balancer_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The ID of the load balancer.</para>
</wadl:doc>
</param>' >
<!-- health monitors -->
<!ENTITY hmResponseParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"

728
api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl
View File

@@ -11,482 +11,384 @@
%common;]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:linkend="http://www.w3.org/1999/linkend"
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">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/"
xml:id="os-lbaas-v2.0">
<resources base="https://neutron.example.com/" xml:id="os-lbaas-v2.0">
<resource id="version" path="//v2.0">
<resource id="lb-vips" path="lb/vips">
<method href="#listVIPs"/>
<method href="#createVIP"/>
<resource id="vip_id" path="{vip_id}">
<param name="vip_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="VIP ID">The UUID
for the VIP.</wadl:doc>
</param>
<method href="#showVIP"/>
<method href="#updateVIP"/>
<method href="#deleteVIP"/>
</resource>
<resource id="loadbalancers" path="loadbalancers">
<method href="#createLoadBalancer"/>
<method href="#listLoadBalancers"/>
<resource id="lb_id" path="{load_balancer_id}">
<method href="#showLoadBalancer"/>
<method href="#updateLoadBalancer"/>
<method href="#deleteLoadBalancer"/>
</resource>
<resource id="lb-healthmonitors"
path="lb/healthmonitors">
<method href="#listHealthMonitors"/>
<method href="#createHealthMonitor"/>
<resource id="health_monitor_id_hm"
path="{health_monitor_id}">
<method href="#showHealthMonitor"/>
<method href="#updateHealthMonitor"/>
<method href="#deleteHealthMonitor"/>
</resource>
</resource>
<resource id="Listeners" path="listeners">
<method href="#createListener"/>
<method href="#listListeners"/>
<resource id="listener_id" path="{listener_id}">
<method href="#showListener"/>
<method href="#updateListener"/>
<method href="#deleteListener"/>
</resource>
<resource id="lb-pools" path="lb/pools">
<method href="#listPools"/>
<method href="#createPool"/>
<resource id="pool_id" path="{pool_id}">
<param name="pool_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID">The
UUID for the pool.</wadl:doc>
</param>
<method href="#showPool"/>
<method href="#updatePool"/>
<method href="#deletePool"/>
<resource id="health_monitors_pool"
path="health_monitors">
<method href="#associateHealthMonitor"/>
<resource id="health_monitor_id_pool"
path="{health_monitor_id}">
<param name="health_monitor_id"
style="template" type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID"
>The UUID for the health
monitor.</wadl:doc>
</param>
<method
href="#disassociateHealthMonitor"/>
</resource>
</resource>
<resource id="lb-pools" path="pools">
<method href="#createPool"/>
<method href="#listPools"/>
<resource id="pool_id" path="{pool_id}">
<method href="#showPool"/>
<method href="#updatePool"/>
<method href="#deletePool"/>
<resource id="lb-members" path="members">
<method href="#createMember"/>
<method href="#listMembers"/>
<resource id="member_id" path="{member_id}">
<method href="#showMember"/>
<method href="#updateMember"/>
<method href="#deleteMember"/>
</resource>
</resource>
</resource>
<resource id="lb-members" path="lb/members">
<method href="#listMembers"/>
<method href="#createMember"/>
<resource id="member_id" path="{member_id}">
<param name="member_id" style="template"
type="csapi:UUID">
<wadl:doc
xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" title="Network ID">The
UUID for the member.</wadl:doc>
</param>
<method href="#showMember"/>
<method href="#updateMember"/>
<method href="#deleteMember"/>
</resource>
</resource>
<resource id="lb-healthmonitors" path="healthmonitors">
<method href="#createHealthMonitor"/>
<method href="#listHealthMonitors"/>
<resource id="health_monitor_id_hm" path="{health_monitor_id}">
<method href="#showHealthMonitor"/>
<method href="#updateHealthMonitor"/>
<method href="#deleteHealthMonitor"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->
<!-- vips -->
<method name="GET" id="listVIPs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List VIPs">
<para role="shortdesc">Lists VIPs.</para>
<!-- load balancer -->
<method name="POST" id="createLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create load balancer">
<para role="shortdesc">Creates a load balancer.</para>
</wadl:doc>
<response status="200"> &vipResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/vips-get-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; </method>
<method name="POST" id="createVIP">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a load balancer VIP">
<para role="shortdesc">Creates a load balancer VIP.</para>
</wadl:doc>
<request> &vipCreateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/VIP-post-req.json"/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-post-req.json"/>
</wadl:doc>&lbCreateRequestParams; </representation>
</request>
<response status="201"> &vipResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/VIP-post-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; </method>
<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
VIP.</para>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-post-resp.json"/>
</wadl:doc> &lbLoadbalancerParam; &lbResponseParams; </representation>
</response> &fault400; &fault401;</method>
<method name="GET" id="listLoadBalancers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List load balancers">
<para role="shortdesc">Lists load balancers.</para>
</wadl:doc>
<response status="200"> &vipResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/VIP-get-detail-resp.json"/>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-list-resp.json"/>
</wadl:doc>
&lbLoadbalancersParam; &lbLoadbalancerParam; &lbResponseParams;
</representation>
</response> &fault401; &fault403; &fault404; </method>
<method name="PUT" id="updateVIP">
</response> &fault401; &fault403; &fault404;</method>
<method name="GET" id="showLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update VIP">
<para role="shortdesc">Updates a specified load balancer
VIP.</para>
title="Show load balancer configuration details">
<para role="shortdesc">Shows the configuration details for a specified load
balancer.</para>
</wadl:doc>
<request> &vipUpdateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/VIP-put-update-req.json"/>
</wadl:doc>
</representation>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-get-detail-resp.json"/>
</wadl:doc> &lbLoadbalancerParam; &lbResponseParams; </representation>
</response> &fault401; &fault403; &fault404;</method>
<method name="PUT" id="updateLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update load balancer">
<para role="shortdesc">Updates the editable attributes of a specified load
balancer</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-put-req.json"/>
</wadl:doc> &lbLoadbalancerParam; &lbUpdateRequestParams; </representation>
</request>
<response status="200"> &vipResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/VIP-put-update-resp.json"/>
<response status="200"><representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-put-resp.json"/>
</wadl:doc> &lbResponseParams; </representation>
</response> &fault400; &fault401; &fault403; &fault404;</method>
<method name="DELETE" id="deleteLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete load balancer">
<para role="shortdesc">Deletes a load balancer.</para>
<para>Upon successful deletion, if the deleted load balancer used any listeners, they
are detached but not deleted.</para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-delete-resp.json"/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404; </method>
<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
VIP.</para>
</response>&fault401; &fault404;&fault409conflict;</method>
<!--Listeners-->
<method name="POST" id="createListener">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create listener">
<para role="shortdesc">Creates a listener.</para>
</wadl:doc>
<response status="204"/> &fault401; &fault404;
&fault409conflict; </method>
<!-- pools -->
<method name="GET" id="listPools">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List pools">
<para role="shortdesc">Lists pools.</para>
</wadl:doc>
<response status="200"> &poolResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/pools-get-resp.json"
/>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/listener-post-req.json"/>
</wadl:doc> &listenerRequestParams; </representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/listener-post-resp.json"/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; </method>
</response>&fault400; &fault401;</method>
<method name="GET" id="listListeners">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List listeners">
<para role="shortdesc">Lists listeners.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/listener-list-resp.json"/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; &fault404;</method>
<method name="GET" id="showListener">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show listener configuration details">
<para role="shortdesc">Shows the configuration details for a specified listener.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/listener-get-detail-resp.json"/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; &fault404;</method>
<method name="PUT" id="updateListener">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update listener">
<para role="shortdesc">Updates editable attributes of a specified listener.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/listener-put-req.json"/>
</wadl:doc> &listenerRequestParams; </representation>
</request>
<response status="200"><representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/listener-put-resp.json"/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404;</method>
<method name="DELETE" id="deleteListener">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete listener">
<para role="shortdesc">Deletes an orphaned listener.</para>
<para>Returns an error if any load balancers still use the listener.</para>
<para>Upon successful deletion, if the deleted listener used any pools, they are
detached but not deleted.</para>
</wadl:doc>
<response status="204"/>&fault401; &fault404;&fault409conflict;</method>
<method name="POST" id="createPool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a load balancer pool">
<para role="shortdesc">Creates a load balancer
pool.</para>
title="Create load balancer pool">
<para role="shortdesc">Creates a load balancer pool.</para>
</wadl:doc>
<request> &poolCreateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/pool-post-req.json"
/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-post-req.json"/>
</wadl:doc> &poolCreateRequestParams; </representation>
</request>
<response status="201"> &vipResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/pool-post-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; </method>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-post-resp.json"/>
</wadl:doc> &poolResponseParams; </representation>
</response> &fault400; &fault401;</method>
<method name="GET" id="listPools">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pools">
<para role="shortdesc">Lists pools.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-list-resp.json"/>
</wadl:doc> &poolResponseParams; </representation>
</response> &fault401; &fault403; &fault404;</method>
<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
pool.</para>
title="Show pool configuration details">
<para role="shortdesc">Shows the configuration details for a specified pool.</para>
</wadl:doc>
<response status="200"> &poolResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/pool-get-detail-resp.json"/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; &fault404; </method>
<response status="200">
<representation mediaType="application/json"><wadl:doc
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-get-detail-resp.json"/>
</wadl:doc> &poolResponseParams; </representation>
</response> &fault401; &fault403; &fault404;</method>
<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
pool.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update pool">
<para role="shortdesc">Updates editable attributes of a specified pool.</para>
</wadl:doc>
<request> &poolUpdateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/pool-put-update.req.json"/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-put-req.json"/>
</wadl:doc> &poolUpdateRequestParams; </representation>
</request>
<response status="200"> &poolResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/Pool-put-update-resp.json"/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404; </method>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-put-resp.json"/>
</wadl:doc> &poolResponseParams; </representation>
</response> &fault400; &fault401; &fault403; &fault404;</method>
<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
pool.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete pool">
<para role="shortdesc">Deletes an orphaned pool.</para>
<para>Returns an error if any listeners still use the pool.</para>
<para>Upon successful deletion, if the deleted pool used any child primitives, they are
detached but not deleted.</para>
</wadl:doc>
<response status="204"/> &fault401; &fault404;
&fault409conflict; </method>
<!-- members -->
<method name="GET" id="listMembers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List members">
<para role="shortdesc">Lists members.</para>
</wadl:doc>
<response status="200"> &memberResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/member-get-resp.json"/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; </method>
<response status="204"/> &fault401; &fault404; &fault409conflict;</method>
<method name="POST" id="createMember">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a load balancer member">
<para role="shortdesc">Creates a load balancer
member.</para>
title="Create load balancer member">
<para role="shortdesc">Creates a load balancer member.</para>
<para>Members are individual back-end services that are being load balanced. Typically,
these are web application servers. They are represented as a pool, IP address, and
Layer 4 port tuple.</para>
</wadl:doc>
<request> &memberCreateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/Member-post-req.json"/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/Member-post-req.json"/>
</wadl:doc> &memberCreateRequestParams; </representation>
</request>
<response status="201"> &memberResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/Member-post-resp.json"/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; </method>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/Member-post-resp.json"/>
</wadl:doc> &memberResponseParams; </representation>
</response> &fault400; &fault401;</method>
<method name="GET" id="listMembers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pool members">
<para role="shortdesc">Lists members in a specified pool.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/member-list-resp.json"/>
</wadl:doc> &memberResponseParams; </representation></response> &fault401;
&fault403; &fault404;</method>
<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
member.</para>
title="Show member configuration details">
<para role="shortdesc">Shows the configuration details for a specified member.</para>
</wadl:doc>
<response status="200"> &memberResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/Member-get-detail-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; &fault404; </method>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/Member-get-detail-resp.json"/>
</wadl:doc> &memberResponseParams; </representation>
</response>&fault401; &fault403; &fault404;</method>
<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
member.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update member">
<para role="shortdesc">Updates a specified load balancer member.</para>
</wadl:doc>
<request> &memberUpdateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/Member-put-update.req.json"
/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/member-put-req.json"/>
</wadl:doc> &memberUpdateRequestParams; </representation>
</request>
<response status="200"> &memberResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/Member-put-update-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404; </method>
<response status="200">
<representation mediaType="application/json"><wadl:doc
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/member-put-resp.json"/>
</wadl:doc> &memberResponseParams; </representation>
</response> &fault400; &fault401; &fault403; &fault404;</method>
<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
member.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete member">
<para role="shortdesc">Deletes a specified load balancer member.</para>
</wadl:doc>
<response status="204"/> &fault401; &fault404;
&fault409conflict; </method>
<!-- health monitors -->
<method name="GET" id="listHealthMonitors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List health monitors">
<para role="shortdesc">Lists health monitors.</para>
</wadl:doc>
<response status="200"> &hmResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code href="api_samples/hms-get-resp.json"/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; </method>
<response status="204"/> &fault401; &fault404; &fault409conflict;</method>
<method name="POST" id="createHealthMonitor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a load balancer health monitor">
<para role="shortdesc">Creates a load balancer health
monitor.</para>
title="Create load balancer health monitor">
<para role="shortdesc">Creates a health monitor.</para>
</wadl:doc>
<request> &hmCreateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-post-req.json"
/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json"><wadl:doc
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/HealthMonitor-post-req.json"/>
</wadl:doc> &hmCreateRequestParams; </representation>
</request>
<response status="201"> &hmResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-post-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; </method>
<response status="201">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/HealthMonitor-post-resp.json"/>
</wadl:doc> &hmResponseParams; </representation>
</response> &fault400; &fault401;</method>
<method name="GET" id="listHealthMonitors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List health monitors">
<para role="shortdesc">Lists health monitors.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/healthmonitor-list-resp.json"/>
</wadl:doc> &hmResponseParams; </representation>
</response> &fault401; &fault403; &fault404;</method>
<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
health monitor.</para>
title="Show health monitor configuration details">
<para role="shortdesc">Shows the configuration details for a specified health
monitor.</para>
</wadl:doc>
<response status="200"> &hmResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-get-detail-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; &fault404; </method>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/HealthMonitor-get-detail-resp.json"/>
</wadl:doc> &hmResponseParams; </representation></response> &fault401; &fault403;
&fault404;</method>
<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
health monitor.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update health monitor">
<para role="shortdesc">Updates the editable attributes of a specified health
monitor.</para>
</wadl:doc>
<request> &hmUpdateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-put-update.req.json"
/>
</wadl:doc>
</representation>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/healthmonitor-put-req.json"/>
</wadl:doc> &hmUpdateRequestParams; </representation>
</request>
<response status="200"> &hmResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-put-update-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; &fault403; &fault404; </method>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/healthmonitor-put-resp.json"/>
</wadl:doc> &hmResponseParams; </representation>
</response> &fault400; &fault401; &fault403; &fault404;</method>
<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
health monitor.</para>
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete health monitor">
<para role="shortdesc">Deletes an orphaned health monitor.</para>
<para>Returns an error if any pools still use the health monitor.</para>
</wadl:doc>
<request> </request>
<response status="204"/> &fault401; &fault404;
&fault409conflict; </method>
<method name="POST" id="associateHealthMonitor">
<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>
</wadl:doc>
<request> &hmCreateRequestParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-post-associate-req.json"
/>
</wadl:doc>
</representation>
</request>
<response status="201"> &hmResponseParams; <representation
mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<xsdxt:code
href="api_samples/HealthMonitor-post-associate-resp.json"
/>
</wadl:doc>
</representation>
</response> &fault400; &fault401; </method>
<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
monitor from a pool.</para>
</wadl:doc>
<response status="204"/> &fault401; &fault404;
&fault409conflict; </method>
<response status="204"/> &fault401; &fault404; &fault409conflict;</method>
</application>