openstack/api-site
Code Issues Proposed changes

Merge "Provides LBaaS v1.0 extension info"

Browse Source
This commit is contained in:
Jenkins
2014-09-14 00:34:41 +00:00
committed by Gerrit Code Review
parent 01121f1ba9 244c8fa25b
commit f721c54c31
15 changed files with 1492 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -22,7 +22,6 @@
<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:method href="#listQuotas"/>
<wadl:method href="#showQuota"/>
<wadl:method href="#updateQuota"/>
<wadl:method href="#resetQuota"/>
@@ -61,7 +60,7 @@
<literal>provider:physical_network</literal>, and
<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"
xlink:href="http://developer.openstack.org/api-ref-networking-v2.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
@@ -133,13 +132,17 @@
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
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>
<section xml:id="lbaas-v1.0">
<title>Load-Balancer-as-a-Service (LBaaS) 1.0 (STABLE)</title>
<para>The LBaaS version 1.0 extension pairs with the
Networking 2.0 API to enable OpenStack tenants to manage
load balancers for their VMs. With this extension
you can load-balance client traffic from one network to application
services, such as VMs, on the same network.</para>
<para>Use this extension to create and manage virtual IP
addresses (VIPs), pools, members of a pool, health
monitors associated with a pool, and view status of a
resource.</para>
<table rules="all" frame="border">
<caption>Load balancer statuses</caption>
<col width="25%"/>
@@ -149,95 +152,40 @@
<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>
<td>ACTIVE</td>
<td>Resource is ready and active.</td>
</tr>
<tr>
<td>PENDING_CREATE</td>
<td>An entity is being created.</td>
<td>No</td>
<td>Resource is being created.</td>
</tr>
<tr>
<td>PENDING_UPDATE</td>
<td>An entity was updated. It remains in an operational state.</td>
<td>Yes</td>
<td>Resource is being updated.</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>
<td>Resource is going to be deleted.</td>
</tr>
<tr>
<td>INACTIVE</td>
<td>Applies to members that fail health checks.</td>
<td>No</td>
<td>Resource is created but not active.</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>
<td>Object within the service is not working. Look
for an extra attribute called <literal>error_details</literal>
for a textual explanation on the error, its
cause, and possibly a solution.</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>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/netconn-api/src/os-lbaasv1.0-ext.wadl"
> </wadl:resources>
</section>
</chapter>

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

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

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

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

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

@@ -0,0 +1,19 @@
{
"health_monitor": {
"admin_state_up": true,
"tenant_id": "4fd44f30292945e481c7b8a0c8908869",
"delay": 5,
"max_retries": 5,
"http_method": "GET",
"timeout": 1,
"pools": [
{
"status": "PENDING_CREATE",
"status_description": null,
"pool_id": "6e55751f-6ad4-4e53-b8d4-02e442cd21df"
}
],
"type": "PING",
"id": "b05e44b5-81f9-4551-b474-711a722698f7"
}
}

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

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

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

@@ -0,0 +1,13 @@
{
"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 Normal file
View File

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

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

@@ -0,0 +1,20 @@
{
"pool":{
"status":"PENDING_UPDATE",
"lb_method":"ROUND_ROBIN",
"protocol":"TCP",
"description":"",
"health_monitors":[
],
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"admin_state_up":true,
"name":"SuperPool",
"members":[
],
"id":"61b1f87a-7a21-4ad3-9dda-7f81d249944f",
"vip_id":null
}
}

25
api-ref/src/wadls/netconn-api/src/api_samples/hms-get-resp.json Normal file
View File

@@ -0,0 +1,25 @@
{
"health_monitors":[
{
"admin_state_up":true,
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"delay":10,
"max_retries":1,
"timeout":1,
"type":"PING",
"id":"466c8345-28d8-4f84-a246-e04380b0461d"
},
{
"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"
}
]
}

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

@@ -0,0 +1,24 @@
{
"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"
}
]
}

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

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

24
api-ref/src/wadls/netconn-api/src/api_samples/pools-get-resp.json Normal file
View File

@@ -0,0 +1,24 @@
{
"pools":[
{
"status":"ACTIVE",
"lb_method":"ROUND_ROBIN",
"protocol":"HTTP",
"description":"",
"health_monitors":[
"466c8345-28d8-4f84-a246-e04380b0461d",
"5d4b5228-33b0-4e60-b225-9b727c1a20e7"
],
"subnet_id":"8032909d-47a1-4715-90af-5153ffe39861",
"tenant_id":"83657cfcdfe44cd5920adaf26c48ceea",
"admin_state_up":true,
"name":"app_pool",
"members":[
"701b531b-111a-4f21-ad85-4795b7b12af6",
"beb53b4d-230b-4abd-8118-575b8fa006ef"
],
"id":"72741b06-df4d-4715-b142-276b6bce75ab",
"vip_id":"4ec89087-d057-4e2c-911f-60a3b47ee304"
}
]
}

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

@@ -992,7 +992,9 @@
<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>
<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">
@@ -1310,7 +1312,8 @@
<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 before changing the status of the member to INACTIVE. A valid 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>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
@@ -1594,6 +1597,826 @@
<para>The administrative state of the member, which is up (<code>true</code>) or down (<code>false</code>).</para>
</wadl:doc>
</param>' >
<!ENTITY vipResponseParams '
<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 admin 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="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>
</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>Human-readable description for the VIP.</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">
<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">
<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. A valid value 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.
A valid value 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. Omit the
<parameter>session_persistence</parameter> parameter to prevent
session persistence. When no session persistence is used,
the <parameter>session_persistence</parameter> parameter does not appear in the
API response.
To clear session persistence for the VIP, set the
<parameter>session_persistence</parameter> parameter to <code>null</code> 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.
Default is <code>-1</code>, meaning no limit.</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. A valid value is
true (UP) or false (DOWN).</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>
</wadl:doc>
</param>' >
<!ENTITY vipCreateRequestParams '
<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 admin user can specify a tenant ID other than its own.</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>Human-readable name for the VIP. 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 VIP.</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 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">
<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. A valid value 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. A valid value 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. Omit the
<parameter>session_persistence</parameter> parameter to prevent
session persistence. When no session persistence is used,
the <parameter>session_persistence</parameter> parameter does not appear in the
API response.
To clear session persistence for the VIP, set the
<parameter>session_persistence</parameter> parameter to <code>null</code> 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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>' >
<!ENTITY vipUpdateRequestParams '
<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>
</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 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. Omit the
<parameter>session_persistence</parameter> parameter to prevent
session persistence. When no session persistence is used,
the <parameter>session_persistence</parameter> parameter does not appear in the
API response.
To clear session persistence for the VIP, set the
<parameter>session_persistence</parameter> parameter to <code>null</code> 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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>' >
<!-- pools -->
<!ENTITY poolResponseParams '
<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>
</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 admin 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="vip_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 VIP with which the pool is associated.</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>Human-readable name for the pool. Does not have to be unique.</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>Human-readable description for 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>
</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. A valid value is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</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"
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="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. A valid value is true (UP) or false (DOWN).</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 pool. Indicates whether the pool is operational.</para>
</wadl:doc>
</param>' >
<!ENTITY poolCreateRequestParams '
<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 admin user can specify a tenant ID other than its own.</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>Human-readable name for the pool. 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>
</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. A valid value is TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</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="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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>' >
<!ENTITY poolUpdateRequestParams '
<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 pool. 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="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="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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>' >
<!-- health monitors -->
<!ENTITY hmResponseParams '
<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 admin 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="type" 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 type of probe sent by the load balancer to verify the member state. A valid value is PING, TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="delay" 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 time, in seconds, between sending probes to members.</para>
</wadl:doc>
</param>
<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 before changing the status of the member to INACTIVE. A valid value is from 1 to 10.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
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="true"
name="url_path" 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 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>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="expected_codes" 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 list of HTTP status codes expected in response from
the member to declare it healthy. Valid values include: a single value,
such as 200, a list, such as 200, 202, or a range, such as 200-204.</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 health monitor. A valid
value is true (UP) or false (DOWN).</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 health monitor. Indicates whether the health monitor is operational.</para>
</wadl:doc>
</param>' >
<!ENTITY hmCreateRequestParams '
<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 admin 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="type" 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 type of probe sent by the load balancer to verify the member state. A valid value is PING, TCP, HTTP, or HTTPS.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="delay" 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 time, in seconds, between sending probes to members.</para>
</wadl:doc>
</param>
<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 before changing the status of the member to INACTIVE. A valid value is from 1 to 10.</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">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The HTTP path of the request sent by the monitor to test the health of a member. A valid value is a string that begins with a forward slash (/).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="expected_codes" 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 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>
</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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>' >
<!ENTITY hmUpdateRequestParams '
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="delay" 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 time, in seconds, between sending probes to members.</para>
</wadl:doc>
</param>
<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 before changing the status of the member to INACTIVE. A valid value is from 1 to 10.</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">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
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>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
name="expected_codes" 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 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>
</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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>' >
<!-- members -->
<!ENTITY memberResponseParams '
<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 member.</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 member. Only an admin 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="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"
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" 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. A valid value 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 the application is hosted.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
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="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 member. A valid value is true (UP) or false (DOWN).</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 member. Indicates whether the member is operational.</para>
</wadl:doc>
</param>' >
<!ENTITY memberCreateRequestParams '
<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 admin 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="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"
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" 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. A valid value 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 the application is hosted.</para>
</wadl:doc>
</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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>
' >
<!ENTITY memberUpdateRequestParams '
<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="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. A valid value is true (UP) or false (DOWN).</para>
</wadl:doc>
</param>
' >
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>

492
api-ref/src/wadls/netconn-api/src/os-lbaasv1.0-ext.wadl Normal file
View File

@@ -0,0 +1,492 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2013-2014 OpenStack Foundation, All Rights Reserved -->
<!--*******************************************************-->
<!-- Import Common XML Entities -->
<!-- -->
<!-- You can resolve the entites with xmllint -->
<!-- -->
<!-- xmllint -noent os-lbaas-ext.wadl -->
<!--*******************************************************-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
%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:csapi="http://docs.openstack.org/compute/api/v1.1">
<!--*******************************************************-->
<!-- All Resources -->
<!--*******************************************************-->
<resources base="https://neutron.example.com/"
xml:id="os-lbaas-v1.0">
<resource id="version" path="v1.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>
<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="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>
</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>
</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>
</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>
<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>
</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>
</representation>
</response> &fault401; &fault403; &fault404; </method>
<method name="PUT" id="updateVIP">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update VIP">
<para role="shortdesc">Updates a specified load balancer
VIP.</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>
</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"/>
</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>
</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"
/>
</wadl:doc>
</representation>
</response> &fault401; &fault403; </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>
</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>
<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>
<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>
</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>
<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>
<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>
<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>
<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>
<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>
<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>
</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>
<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>
<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>
</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>
<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>
<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>
<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>
<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>
<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>
<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>
</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>
<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>
<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>
</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>
<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>
<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>
<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>
<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>
<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>
</application>

0
api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl → api-ref/src/wadls/netconn-api/src/os-lbaasv2.0-ext.wadl
View File