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
Deleted the unused file:os-lbaas-ext-origional.wadl
Listener parameters added properly
Removed unused code samples
Corrected the discrepancies according to the updated google doc
Edits for consistency and clarity (DF)

Change-Id: I5a0f4eae1ae7dec4478bc06298c89ceee0553334
Closes-Bug: #1331525
This commit is contained in:
minwang 2014-07-09 17:13:36 -07:00 committed by Diane Fleming
parent 157c21616a
commit 567d54ea4e
7 changed files with 509 additions and 349 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,6 +31,7 @@
</section> </section>
<section xml:id="network_provider-ext"> <section xml:id="network_provider-ext">
<title>Networks provider extended attributes (networks)</title> <title>Networks provider extended attributes (networks)</title>
<para>List, create, show information for, update, and delete networks.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <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="#listNetworks"/>
@ -70,6 +71,7 @@
</section> </section>
<section xml:id="port_binding-ext"> <section xml:id="port_binding-ext">
<title>Ports binding extended attributes (ports)</title> <title>Ports binding extended attributes (ports)</title>
<para>List, create, show information for, and update ports.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <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="#listPorts"/>
@ -83,6 +85,8 @@
</section> </section>
<section xml:id="security_groups"> <section xml:id="security_groups">
<title>Security groups and rules (security-groups)</title> <title>Security groups and rules (security-groups)</title>
<para>List, create, show information for, and delete security groups and security group
rules.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <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="#listSecGroups"/>
@ -136,7 +140,104 @@
services, such as VMs, on the same or a different network. You can load-balance several 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 protocols, such as TCP and HTTP and monitor the health of application services. The
LBaaS extension supports session persistence.</para> LBaaS extension supports session persistence.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02" <table rules="all" frame="border">
href="../wadls/netconn-api/src/os-lbaas-ext.wadl"/> <caption>Load balancer statuses</caption>
<col width="25%"/>
<col width="50%"/>
<col width="25%"/>
<thead>
<tr>
<th>Status</th>
<th>Description</th>
<th>Operational</th>
</tr>
</thead>
<tbody>
<tr>
<td>DEFERRED</td>
<td>An entity was created but is not yet linked to a load balancer.</td>
<td>No</td>
</tr>
<tr>
<td>PENDING_CREATE</td>
<td>An entity is being created.</td>
<td>No</td>
</tr>
<tr>
<td>PENDING_UPDATE</td>
<td>An entity was updated. It remains in an operational state.</td>
<td>Yes</td>
</tr>
<tr>
<td>PENDING_DELETE</td>
<td>An entity is in the process of being deleted.</td>
<td>No</td>
</tr>
<tr>
<td>ACTIVE</td>
<td>An entity is in a normal operational state.</td>
<td>Yes</td>
</tr>
<tr>
<td>INACTIVE</td>
<td>Applies to members that fail health checks.</td>
<td>No</td>
</tr>
<tr>
<td>ERROR</td>
<td>Something has gone wrong.</td>
<td>This might be in either an operational or non-operational state.</td>
</tr>
</tbody>
</table>
<para>Use this extension to create and manage load balancers, listeners, pools, members, and
health monitors.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#loadbalancers">
<wadl:method href="#createLoadBalancer"/>
<wadl:method href="#listLoadBalancers"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#lb_id">
<wadl:method href="#showLoadBalancer"/>
<wadl:method href="#updateLoadBalancer"/>
<wadl:method href="#deleteLoadBalancer"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#Listeners">
<wadl:method href="#createListener"/>
<wadl:method href="#listListeners"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#listener_id">
<wadl:method href="#showListener"/>
<wadl:method href="#updateListener"/>
<wadl:method href="#deleteListener"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#lb-pools">
<wadl:method href="#createPool"/>
<wadl:method href="#listPools"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#pool_id">
<wadl:method href="#showPool"/>
<wadl:method href="#updatePool"/>
<wadl:method href="#deletePool"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#lb-members">
<wadl:method href="#createMember"/>
<wadl:method href="#listMembers"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#member_id">
<wadl:method href="#showMember"/>
<wadl:method href="#updateMember"/>
<wadl:method href="#deleteMember"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#lb-healthmonitors">
<wadl:method href="#createHealthMonitor"/>
<wadl:method href="#listHealthMonitors"/>
</wadl:resource>
<wadl:resource href="../wadls/netconn-api/src/os-lbaas-ext.wadl#health_monitor_id_hm">
<wadl:method href="#showHealthMonitor"/>
<wadl:method href="#updateHealthMonitor"/>
<wadl:method href="#deleteHealthMonitor"/>
</wadl:resource>
</wadl:resources>
</section> </section>
</chapter> </chapter>

2
api-ref/src/wadls/netconn-api/src/api_samples/healthmonitor-put-req.json
View File

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

28
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-list-resp.json
View File

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

23
api-ref/src/wadls/netconn-api/src/api_samples/loadbalancer-post-resp.json
View File

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

34
api-ref/src/wadls/netconn-api/src/api_samples/member-list-resp.json
View File

@ -1,12 +1,24 @@
{ {
"members":{ "members": [
"id":"975592ca-e308-48ad-8298-731935ee9f45", {
"address":"192.0.2.14", "id": "975592ca-e308-48ad-8298-731935ee9f45",
"protocol_port":8080, "address": "192.0.2.14",
"tenant_id":"453105b9-1754-413f-aab1-55f1af620750", "protocol_port": 8080,
"admin_state_up":true, "tenant_id": "453105b9-1754-413f-aab1-55f1af620750",
"weight":1, "admin_state_up": true,
"subnet_id":"SUBNET_ID", "weight": 1,
"status":"DOWN" "subnet_id": "SUBNET_ID",
} "status": "DOWN"
} },
{
"id": "975592ca-e308-48ad-8298-731935ee9f46",
"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"
}
]
}

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

@ -135,9 +135,7 @@
name="admin_state_up" style="plain" type="xsd:bool"> name="admin_state_up" style="plain" type="xsd:bool">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The administrative state of the network. A valid value <para>The administrative state of the network, which is up (<code>true</code>) or down (<code>false</code>).</para></wadl:doc>
is up (<code>true</code>) or down
(<code>false</code>).</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string"> name="name" style="plain" type="xsd:string">
@ -201,71 +199,89 @@
provider segments.</para></wadl:doc> provider segments.</para></wadl:doc>
</param>'> </param>'>
<!ENTITY portListParameters <!ENTITY portListParameters
'<param xmlns="http://wadl.dev.java.net/2009/02" required="true" '<param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="status"
name="status" style="plain" type="xsd:string"> style="plain" type="xsd:string">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
<para>The port status. Value is ACTIVE or DOWN.</para></wadl:doc> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</param> <para>The port status. Value is ACTIVE or DOWN.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" </param>
name="name" style="plain" type="xsd:string"> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="name"
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> style="plain" type="xsd:string">
<para>The port name.</para></wadl:doc> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
</param> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <para>The port name.</para></wadl:doc>
name="allowed_address_pairs" style="plain" type="xsd:dict"> </param>
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
<para>Allowed address pairs.</para></wadl:doc> name="allowed_address_pairs" style="plain" type="xsd:dict">
</param> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
name="admin_state_up" style="plain" type="xsd:bool"> <para>Allowed address pairs.</para></wadl:doc>
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> </param>
<para>The administrative state of the router, which is up (<code>true</code>) or down (<code>false</code>).</para></wadl:doc> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="admin_state_up"
</param> style="plain" type="xsd:bool">
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
name="network_id" style="plain" type="csapi:uuid"> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <para>The administrative state of the router, which is up (<code>true</code>) or
<para>The ID of the attached network.</para></wadl:doc> down (<code>false</code>).</para></wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="network_id"
name="tenant_id" style="plain" type="csapi:uuid"> style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
<para>The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.</para></wadl:doc> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</param> <para>The ID of the attached network.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" </param>
name="extra_dhcp_opts" style="plain" type="xsd:dict"> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="tenant_id"
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> style="plain" type="csapi:uuid">
<para>Extra DHCP options.</para></wadl:doc> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
</param> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <para>The ID of the tenant who owns the network. Only administrative users can
name="device_owner" style="plain" type="xsd:string"> specify a tenant ID other than their own.</para></wadl:doc>
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> </param>
<para>The ID of the entity that uses this port. For example, a dhcp agent.</para></wadl:doc> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="extra_dhcp_opts"
</param> style="plain" type="xsd:dict">
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
name="mac_address" style="plain" type="xsd:string"> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <para>Extra DHCP options.</para></wadl:doc>
<para>The MAC address of the port.</para></wadl:doc> </param>
</param> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="device_owner"
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" style="plain" type="xsd:string">
name="fixed_ips" style="plain" type="xsd:dict"> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>IP addresses for the port. Includes the IP address and subnet ID.</para></wadl:doc> <para>The ID of the entity that uses this port. For example, a dhcp
</param> agent.</para></wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" </param>
name="id" style="plain" type="csapi:uuid"> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="mac_address"
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> style="plain" type="xsd:string">
<para>The ID of the port.</para></wadl:doc> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
</param> xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <para>The MAC address of the port.</para></wadl:doc>
name="security_groups" style="plain" type="csapi:uuid"> </param>
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="fixed_ips"
<para>The IDs of any attached security groups.</para></wadl:doc> style="plain" type="xsd:dict">
</param> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
name="device_id" style="plain" type="csapi:uuid"> <para>IP addresses for the port. Includes the IP address and subnet
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> ID.</para></wadl:doc>
<para>The ID of the device that uses this port. For example, a virtual server.</para></wadl:doc> </param>
</param>'> <param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="id" style="plain"
type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the port.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="security_groups"
style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The IDs of any attached security groups.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" name="device_id"
style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the device that uses this port. For example, a virtual
server.</para></wadl:doc>
</param>'>
<!-- Port Create Parameters --> <!-- Port Create Parameters -->
<!ENTITY portCreateParameters <!ENTITY portCreateParameters
'<param xmlns="http://wadl.dev.java.net/2009/02" required="false" '<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@ -306,7 +322,7 @@
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="network_id" style="plain" type="csapi:uuid"> name="network_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The ID of the the network.</para></wadl:doc> <para>The ID of the network.</para></wadl:doc>
</param> '> </param> '>
<!-- Port binding Parameters --> <!-- Port binding Parameters -->
<!ENTITY portBindingParameters ' <!ENTITY portBindingParameters '
@ -883,6 +899,13 @@
<para>The status of the load balancer. Indicates whether the load balancer is operational.</para> <para>The status of the load balancer. Indicates whether the load balancer is operational.</para>
</wadl:doc> </wadl:doc>
</param> </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 load balancer, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="tenant_id" style="plain" type="csapi:uuid"> name="tenant_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -942,7 +965,7 @@
</wadl:doc> </wadl:doc>
</param>' > </param>' >
<!-- pools --> <!-- pools -->
<!ENTITY poolResponseParams ' <!ENTITY poolcreateResponseParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="status" style="plain" type="xsd:string"> name="status" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -950,14 +973,6 @@
<para>The status of the pool. Indicates whether the pool is operational.</para> <para>The status of the pool. Indicates whether the pool is operational.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="lb_method" 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 algorithm that is used to distribute the load among pool members.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol" style="plain" type="xsd:string"> name="protocol" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -966,28 +981,12 @@
<para>The protocol of the pool, which is TCP, HTTP, or HTTPS.</para> <para>The protocol of the pool, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="description" style="plain" type="xsd:string"> name="description" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Human readable description for the pool.</para> <para>Description for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="health_monitors" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of health monitors that are associated with the pool.</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 network to which pool members belong.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -998,7 +997,7 @@
<para>Owner of the pool. Only an administrative user can specify a tenant ID other than its own.</para> <para>Owner of the pool. Only an administrative user can specify a tenant ID other than its own.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:boolean"> name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
@ -1010,15 +1009,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Human readable name for the pool. Does not have to be unique.</para> <para>Pool name. Does not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="health_monitors_status" 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>List of statuses for associated health monitors, if any.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1030,19 +1021,26 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="provider" style="plain" type="xsd:string"> name="lb_algorithm" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Provider name of the load-balancer service.</para> <para>The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported.</para> </wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="healthmonitor_id" 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 ID of the health monitor.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="status_description" style="plain" type="xsd:string"> name="session_persistence" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Status description.</para> <para>The session persistence algorithm. This algorithm is a dictionary with <literal>type</literal> and <literal>cookie_name</literal> keys.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1052,13 +1050,91 @@
xml:lang="EN"> xml:lang="EN">
<para>The unique ID for the pool.</para> <para>The unique ID for the pool.</para>
</wadl:doc> </wadl:doc>
</param>' >
<!ENTITY poolResponseParams '
<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 pool. Indicates whether the pool is operational.</para>
</wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="vip_id" style="plain" type="xsd:string"> name="lb_algorithm" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The ID of the VIP with which the pool is associated.</para> <para>The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported.</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 pool, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
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>Description for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="healthmonitor_id" style="plain" type="xsd:list">
<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 health monitor.</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 pool. 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="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 pool, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
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>Pool name. Does not have to be unique.</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 algorithm that should be used (if any). This is a dictionary that has keys of "type" and "cookie_name"..</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="members" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of members that belong to the pool.</para>
</wadl:doc>
</param>
<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 pool.</para>
</wadl:doc> </wadl:doc>
</param>' > </param>' >
<!ENTITY poolCreateRequestParams ' <!ENTITY poolCreateRequestParams '
@ -1070,28 +1146,12 @@
<para>Owner of the pool. Only an administrative user can specify a tenant ID other than its own.</para> <para>Owner of the pool. Only an administrative user can specify a tenant ID other than its own.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string"> name="name" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Human readable name for the pool. Does not have to be unique.</para> <para>Pool name. Does not have to be unique.</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>Human readable description for the pool.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
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 network to which pool members belong.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1103,43 +1163,51 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="lb_method" style="plain" type="xsd:string"> name="lb_algorithm" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The algorithm that is used to distribute the load among pool members.</para> <para>The load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported.</para> </wadl:doc>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="health_monitors" style="plain" type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of health monitors that are associated with the pool.</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 pool, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="provider" 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>Provider name of the load-balancer service.</para>
</wadl:doc>
</param>' > </param>' >
<!ENTITY poolUpdateRequestParams ' <!ENTITY poolUpdateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="name" style="plain" type="xsd:string"> name="name" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Human readable name for the pool. Does not have to be unique.</para> <para>Pool name. Does not have to be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="lb_algorithm" 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 load-balancer algorithm, which is round-robin, least-connections, and so on. This value, which must be supported, is dependent on the load-balancer provider. Round robin must be supported.</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>ID of default pool. Must have compatible protocol with listener.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
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> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@ -1147,30 +1215,53 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Human readable description for the pool.</para> <para>Detailed description of the listener.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="lb_method" style="plain" type="xsd:string"> name="tenant_id" style="plain" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The algorithm that is used to distribute the load among pool members.</para> <para>Tenant that owns this listener.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="health_monitors" style="plain" type="xsd:list"> name="connection_limit" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>List of health monitors that are associated with the pool.</para> <para>Maximum connections this load balancer can have. Default is infinite.</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>Protocol to load balance: HTTP, HTTPS, TCP, UDP.</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>TCP (or UDP) port to listen on.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:boolean"> name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the pool, which is up (<code>true</code>) or down (<code>false</code>).</para> <para>The administrative state of the load balancer, which is up (<code>true</code>) or down (<code>false</code>).</para>
<para>If you set this attribute to <code>false</code>, the listener is created in an administratively down state.</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> </wadl:doc>
</param>' > </param>' >
<!ENTITY listenerRequestParams ' <!ENTITY listenerRequestParams '
@ -1291,10 +1382,10 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Number of allowed connection failures before changing the status of the member to INACTIVE. A valie value is from 1 to 10.</para> <para>Number of allowed connection failures before changing the status of the member to INACTIVE. A valid value is from 1 to 10.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="http_method" style="plain" type="xsd:string"> name="http_method" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -1302,7 +1393,7 @@
<para>The HTTP method that the monitor uses for requests.</para> <para>The HTTP method that the monitor uses for requests.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="url_path" style="plain" type="xsd:string"> name="url_path" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
@ -1310,15 +1401,15 @@
<para>The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/).</para> <para>The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/).</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="expected_codes" style="plain" type="xsd:string"> name="expected_codes" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The list of HTTP status codes expected in response from the member to declare it healthy. A valid value is a single value, such as 200, a list, such as 200, 202, or a range, such as 200-204.</para> <para>Expected HTTP codes for a passing HTTP(S) monitor.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:boolean"> name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
@ -1362,7 +1453,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The maximum number of seconds for a monitor to wait for a connection to be established before it times out. This value must be less than the delay value.</para> <para>Time in seconds to timeout each probe.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1370,15 +1461,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>Number of allowed connection failures before changing the status of the member to INACTIVE. A valid value is from 1 to 10.</para> <para>Maximum consecutive health probe tries.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="http_method" 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 HTTP method that the monitor uses for requests.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@ -1386,7 +1469,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/).</para> <para>Path portion of URI that will be probed if type is HTTP(S).</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@ -1394,14 +1477,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The list of HTTP status codes expected in response from the member to declare it healthy. A valid value is a single value, such as 200, a list, such as 200, 202, or a range, such as 200-204.</para> <para>Expected HTTP codes for a passing HTTP(S) monitor.</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 health monitor, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc> </wadl:doc>
</param>' > </param>' >
<!ENTITY hmUpdateRequestParams ' <!ENTITY hmUpdateRequestParams '
@ -1414,30 +1490,6 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="timeout" 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 seconds for a monitor to wait for a connection to be established before it times out. This value must be less than the delay value.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="max_retries" 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>Number of allowed connection failures, from 1 to 10, before the status of the member changes to INACTIVE</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="http_method" 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 HTTP method that the monitor uses for requests.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="url_path" style="plain" type="xsd:string"> name="url_path" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
@ -1445,25 +1497,72 @@
the health of a member. A valid value is a string that the health of a member. A valid value is a string that
begins with a forward slash (/).</para> begins with a forward slash (/).</para>
</wadl:doc> </wadl:doc>
</param> </param>' >
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <!-- members -->
name="expected_codes" style="plain" type="xsd:string"> <!ENTITY membercreateResponseParams '
<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" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02"
<para>The list of HTTP status codes expected in response from xml:lang="EN">
the member to declare it healthy. A valid value is <para>The unique ID for the member.</para>
single value, such as 200, a list, such as 200, 202, or a </wadl:doc>
range, such as 200-204.</para> </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 member. 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="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>Subnet in which to access this member.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
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 member.</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 the application is hosted.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="weight" 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>A positive integer value that indicates the relative portion of traffic that this
member should receive from the pool. For example, a member with a weight of 10 receives five times
as much traffic as a member with a weight of 2.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="admin_state_up" style="plain" type="xsd:boolean"> name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The administrative state of the health monitor, which is up (<code>true</code>) or down (<code>false</code>).</para> <para>The administrative state of the member, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc> </wadl:doc>
</param>' > </param>
<!-- members --> <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 member. Indicates whether the member is operational.</para>
</wadl:doc>
</param>'>
<!ENTITY memberResponseParams ' <!ENTITY memberResponseParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="id" style="plain" type="csapi:uuid"> name="id" style="plain" type="csapi:uuid">
@ -1482,11 +1581,11 @@
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="pool_id" style="plain" type="csapi:uuid"> name="subnet_id" style="plain" type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The ID of the pool to which the member belongs.</para> <para>Subnet in which to access this member.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1497,14 +1596,6 @@
<para>The IP address of the member.</para> <para>The IP address of the member.</para>
</wadl:doc> </wadl:doc>
</param> </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 VIP address, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol_port" style="plain" type="xsd:int"> name="protocol_port" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1517,12 +1608,7 @@
name="weight" style="plain" type="xsd:int"> name="weight" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The weight of a member determines the portion of <para>Weight of member.</para>
requests or connections it services compared to the other
members of the pool. A value of 0 means the member does
not participate in load-balancing but still accepts
persistent connections. A valid value is from 0 to
256.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
@ -1548,14 +1634,6 @@
<para>Owner of the member. Only an administrative user can specify a tenant ID other than its own.</para> <para>Owner of the member. Only an administrative user can specify a tenant ID other than its own.</para>
</wadl:doc> </wadl:doc>
</param> </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 to which the member belongs.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="address" style="plain" type="xsd:ip"> name="address" style="plain" type="xsd:ip">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1564,14 +1642,6 @@
<para>The IP address of the member.</para> <para>The IP address of the member.</para>
</wadl:doc> </wadl:doc>
</param> </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 VIP address, which is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="protocol_port" style="plain" type="xsd:int"> name="protocol_port" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -1580,50 +1650,16 @@
<para>The port on which the application is hosted.</para> <para>The port on which the application is hosted.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="weight" 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 weight of a member determines the portion of
requests or connections it services compared to the other
members of the pool. A value of 0 means the member does
not participate in load-balancing but still accepts
persistent connections. A valid value is from 0 to
256.</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 member, which is up
(<code>true</code>) or down
(<code>false</code>).</para>
</wadl:doc>
</param>
' >
<!ENTITY memberUpdateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true" <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="pool_id" style="plain" type="csapi:uuid"> name="subnet_id" style="plain" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para>The ID of the pool to which the member belongs.</para> <para>Subnet in which to access this member.</para>
</wadl:doc> </wadl:doc>
</param> </param>' >
<param xmlns="http://wadl.dev.java.net/2009/02" required="false" <!ENTITY memberUpdateRequestParams '
name="weight" style="plain" type="xsd:int"> <param xmlns="http://wadl.dev.java.net/2009/02" required="true"
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The weight of a member determines the portion of
requests or connections it services compared to the other
members of the pool. A value of 0 means the member does
not participate in load-balancing but still accepts
persistent connections. A valid value is from 0 to
256.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="admin_state_up" style="plain" type="xsd:boolean"> name="admin_state_up" style="plain" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">

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

@ -89,20 +89,19 @@
</response> &fault400; &fault401;</method> </response> &fault400; &fault401;</method>
<method name="GET" id="listLoadBalancers"> <method name="GET" id="listLoadBalancers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List load balancers"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List load balancers">
<para role="shortdesc">Lists load balancers.</para> <para role="shortdesc">Lists all load balancers.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loadbalancer-list-resp.json"/> <xsdxt:code href="api_samples/loadbalancer-list-resp.json"/>
</wadl:doc> </wadl:doc> &lbLoadbalancersParam; &lbLoadbalancerParam; &lbResponseParams;
&lbLoadbalancersParam; &lbLoadbalancerParam; &lbResponseParams;
</representation> </representation>
</response> &fault401; &fault403; &fault404;</method> </response> &fault401; &fault403; &fault404;</method>
<method name="GET" id="showLoadBalancer"> <method name="GET" id="showLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show load balancer configuration details"> title="Show load balancer configuration details">
<para role="shortdesc">Shows the configuration details for a specified load <para role="shortdesc">Shows the details of the configuration for a specified load
balancer.</para> balancer.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
@ -114,7 +113,7 @@
<method name="PUT" id="updateLoadBalancer"> <method name="PUT" id="updateLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update load balancer"> <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 <para role="shortdesc">Updates the editable attributes of a specified load
balancer</para> balancer.</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -130,8 +129,8 @@
<method name="DELETE" id="deleteLoadBalancer"> <method name="DELETE" id="deleteLoadBalancer">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete load balancer"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete load balancer">
<para role="shortdesc">Deletes a load balancer.</para> <para role="shortdesc">Deletes a load balancer.</para>
<para>Upon successful deletion, if the deleted load balancer used any listeners, they <para>Upon successful deletion, any listeners that this load balancer still uses are
are detached but not deleted.</para> detached but not deleted.</para>
</wadl:doc> </wadl:doc>
<response status="204"> <response status="204">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -160,7 +159,7 @@
</response>&fault400; &fault401;</method> </response>&fault400; &fault401;</method>
<method name="GET" id="listListeners"> <method name="GET" id="listListeners">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List listeners"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List listeners">
<para role="shortdesc">Lists listeners.</para> <para role="shortdesc">Lists all listeners.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -172,7 +171,8 @@
<method name="GET" id="showListener"> <method name="GET" id="showListener">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show listener configuration details"> title="Show listener configuration details">
<para role="shortdesc">Shows the configuration details for a specified listener.</para> <para role="shortdesc">Shows the details of the configuration for a specified
listener.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -200,9 +200,8 @@
<method name="DELETE" id="deleteListener"> <method name="DELETE" id="deleteListener">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete listener"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete listener">
<para role="shortdesc">Deletes an orphaned listener.</para> <para role="shortdesc">Deletes an orphaned listener.</para>
<para>Returns an error if any load balancers still use the listener.</para> <para>Returns an error if any load balancers still use this listener. Any pool that this
<para>Upon successful deletion, if the deleted listener used any pools, they are listener still uses are detached but not deleted.</para>
detached but not deleted.</para>
</wadl:doc> </wadl:doc>
<response status="204"/>&fault401; &fault404;&fault409conflict;</method> <response status="204"/>&fault401; &fault404;&fault409conflict;</method>
<method name="POST" id="createPool"> <method name="POST" id="createPool">
@ -220,11 +219,11 @@
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/pool-post-resp.json"/> <xsdxt:code href="api_samples/pool-post-resp.json"/>
</wadl:doc> &poolResponseParams; </representation> </wadl:doc> &poolcreateResponseParams; </representation>
</response> &fault400; &fault401;</method> </response> &fault400; &fault401;</method>
<method name="GET" id="listPools"> <method name="GET" id="listPools">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pools"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pools">
<para role="shortdesc">Lists pools.</para> <para role="shortdesc">Lists all pools.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -235,7 +234,8 @@
<method name="GET" id="showPool"> <method name="GET" id="showPool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show pool configuration details"> title="Show pool configuration details">
<para role="shortdesc">Shows the configuration details for a specified pool.</para> <para role="shortdesc">Shows the details of the configuration for a specified
pool.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"><wadl:doc <representation mediaType="application/json"><wadl:doc
@ -285,7 +285,7 @@
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/Member-post-resp.json"/> <xsdxt:code href="api_samples/Member-post-resp.json"/>
</wadl:doc> &memberResponseParams; </representation> </wadl:doc> &membercreateResponseParams; </representation>
</response> &fault400; &fault401;</method> </response> &fault400; &fault401;</method>
<method name="GET" id="listMembers"> <method name="GET" id="listMembers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pool members"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List pool members">
@ -300,7 +300,7 @@
<method name="GET" id="showMember"> <method name="GET" id="showMember">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show member configuration details"> title="Show member configuration details">
<para role="shortdesc">Shows the configuration details for a specified member.</para> <para role="shortdesc">Shows the details of the configuration for a member.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -348,7 +348,7 @@
</response> &fault400; &fault401;</method> </response> &fault400; &fault401;</method>
<method name="GET" id="listHealthMonitors"> <method name="GET" id="listHealthMonitors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List health monitors"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List health monitors">
<para role="shortdesc">Lists health monitors.</para> <para role="shortdesc">Lists all health monitors.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -359,7 +359,7 @@
<method name="GET" id="showHealthMonitor"> <method name="GET" id="showHealthMonitor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show health monitor configuration details"> title="Show health monitor configuration details">
<para role="shortdesc">Shows the configuration details for a specified health <para role="shortdesc">Shows the details of the configuration for a specified health
monitor.</para> monitor.</para>
</wadl:doc> </wadl:doc>
<response status="200"> <response status="200">