Add api doc. for the l3 metering extension
Partial-bug: #1202967 Change-Id: Ifd34556a616f67afee704afe1167c61c2d257592
This commit is contained in:
Sylvain Afchain
parent
ed9b7056e6
commit
469285043c
@ -2720,5 +2720,6 @@ Date: Wed, 12 Sep 2012 11:36:20 GMT</literallayout>
|
||||
<xi:include href="neutron-vpn-ext.xml"/>
|
||||
<xi:include href="neutron-allowed-address-pair-ext.xml"/>
|
||||
<xi:include href="neutron-extra-dhcp-opt-ext.xml"/>
|
||||
<xi:include href="neutron-metering-ext.xml"/>
|
||||
</chapter>
|
||||
</book>
|
||||
|
||||
44
v2.0/neutron-metering-ext.xml
Normal file
44
v2.0/neutron-metering-ext.xml
Normal file
@ -0,0 +1,44 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE section [
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
<!ENTITY plusmn "±">
|
||||
|
||||
<!-- 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>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
|
||||
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="figures/Check_mark_23x20_02.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
|
||||
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="figures/Arrow_east.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
<!ENTITY APIv2 'Networking API v2.0'>
|
||||
]>
|
||||
<section xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml"
|
||||
xmlns:db="http://docbook.org/ns/docbook" version="5.0"
|
||||
status="final" xml:id="metering-ext"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
|
||||
<title>Metering Labels and Rules</title>
|
||||
<para>Creates, modifies, and deletes OpenStack Layer3 Metering labels
|
||||
and rules. </para>
|
||||
<wadl:resources href="wadl/metering-labels.wadl"/>
|
||||
</section>
|
||||
13
v2.0/samples/metering-label-create-req.json
Normal file
13
v2.0/samples/metering-label-create-req.json
Normal file
@ -0,0 +1,13 @@
|
||||
POST /v2.0/metering/metering-labels HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
|
||||
{
|
||||
"metering_label":{
|
||||
"name":"label1",
|
||||
"description":"description of label1"
|
||||
}
|
||||
}
|
||||
8
v2.0/samples/metering-label-create-resp.json
Normal file
8
v2.0/samples/metering-label-create-resp.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"metering_label": {
|
||||
"tenant_id": "45345b0ee1ea477fac0f541b2cb79cd4",
|
||||
"description": "description of label1",
|
||||
"name": "label1",
|
||||
"id": "bc91b832-8465-40a7-a5d8-ba87de442266"
|
||||
}
|
||||
}
|
||||
6
v2.0/samples/metering-label-delete-req.json
Normal file
6
v2.0/samples/metering-label-delete-req.json
Normal file
@ -0,0 +1,6 @@
|
||||
DELETE /v2.0/metering/metering-labels/a6700594-5b7a-4105-8bfe-723b346ce866 HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
1
v2.0/samples/metering-label-delete-resp.json
Normal file
1
v2.0/samples/metering-label-delete-resp.json
Normal file
@ -0,0 +1 @@
|
||||
status: 204
|
||||
6
v2.0/samples/metering-label-get-req.json
Normal file
6
v2.0/samples/metering-label-get-req.json
Normal file
@ -0,0 +1,6 @@
|
||||
GET /v2.0/metering/metering-labels/a6700594-5b7a-4105-8bfe-723b346ce866 HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
8
v2.0/samples/metering-label-get-resp.json
Normal file
8
v2.0/samples/metering-label-get-resp.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"metering_label": {
|
||||
"tenant_id": "45345b0ee1ea477fac0f541b2cb79cd4",
|
||||
"description": "label1 description",
|
||||
"name": "label1",
|
||||
"id": "a6700594-5b7a-4105-8bfe-723b346ce866"
|
||||
}
|
||||
}
|
||||
14
v2.0/samples/metering-label-rule-create-req.json
Normal file
14
v2.0/samples/metering-label-rule-create-req.json
Normal file
@ -0,0 +1,14 @@
|
||||
POST /v2.0/metering/metering-label-rules HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
|
||||
{
|
||||
"metering_label_rule":{
|
||||
"remote_ip_prefix":"10.0.1.0/24",
|
||||
"direction":"ingress",
|
||||
"metering_label_id":"e131d186-b02d-4c0b-83d5-0c0725c4f812"
|
||||
}
|
||||
}
|
||||
9
v2.0/samples/metering-label-rule-create-resp.json
Normal file
9
v2.0/samples/metering-label-rule-create-resp.json
Normal file
@ -0,0 +1,9 @@
|
||||
{
|
||||
"metering_label_rule":{
|
||||
"remote_ip_prefix":"10.0.1.0/24",
|
||||
"direction":"ingress",
|
||||
"metering_label_id":"e131d186-b02d-4c0b-83d5-0c0725c4f812",
|
||||
"id":"00e13b58-b4f2-4579-9c9c-7ac94615f9ae",
|
||||
"excluded":false
|
||||
}
|
||||
}
|
||||
6
v2.0/samples/metering-label-rule-delete-req.json
Normal file
6
v2.0/samples/metering-label-rule-delete-req.json
Normal file
@ -0,0 +1,6 @@
|
||||
DELETE /v2.0/metering/metering-labels/37b31179-71ee-4f0a-b130-0eeb28e7ede7 HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
1
v2.0/samples/metering-label-rule-delete-resp.json
Normal file
1
v2.0/samples/metering-label-rule-delete-resp.json
Normal file
@ -0,0 +1 @@
|
||||
status: 204
|
||||
6
v2.0/samples/metering-label-rule-get-req.json
Normal file
6
v2.0/samples/metering-label-rule-get-req.json
Normal file
@ -0,0 +1,6 @@
|
||||
GET /v2.0/metering/metering-label-rules/9536641a-7d14-4dc5-afaf-93a973ce0eb8 HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
9
v2.0/samples/metering-label-rule-get-resp.json
Normal file
9
v2.0/samples/metering-label-rule-get-resp.json
Normal file
@ -0,0 +1,9 @@
|
||||
{
|
||||
"metering_label_rule": {
|
||||
"remote_ip_prefix": "20.0.0.0\/24",
|
||||
"direction": "ingress",
|
||||
"metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
|
||||
"id": "9536641a-7d14-4dc5-afaf-93a973ce0eb8",
|
||||
"excluded": false
|
||||
}
|
||||
}
|
||||
6
v2.0/samples/metering-label-rules-list-get-req.json
Normal file
6
v2.0/samples/metering-label-rules-list-get-req.json
Normal file
@ -0,0 +1,6 @@
|
||||
GET /v2.0/metering/metering-label-rules HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
18
v2.0/samples/metering-label-rules-list-get-resp.json
Normal file
18
v2.0/samples/metering-label-rules-list-get-resp.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"metering_label_rules": [
|
||||
{
|
||||
"remote_ip_prefix": "20.0.0.0\/24",
|
||||
"direction": "ingress",
|
||||
"metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
|
||||
"id": "9536641a-7d14-4dc5-afaf-93a973ce0eb8",
|
||||
"excluded": false
|
||||
},
|
||||
{
|
||||
"remote_ip_prefix": "10.0.0.0\/24",
|
||||
"direction": "ingress",
|
||||
"metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
|
||||
"id": "ffc6fd15-40de-4e7d-b617-34d3f7a93aec",
|
||||
"excluded": false
|
||||
}
|
||||
]
|
||||
}
|
||||
6
v2.0/samples/metering-labels-list-get-req.json
Normal file
6
v2.0/samples/metering-labels-list-get-req.json
Normal file
@ -0,0 +1,6 @@
|
||||
GET /v2.0/metering/metering-labels HTTP/1.1
|
||||
Host: controlnode:9696
|
||||
User-Agent: python-neutronclient
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
|
||||
16
v2.0/samples/metering-labels-list-get-resp.json
Normal file
16
v2.0/samples/metering-labels-list-get-resp.json
Normal file
@ -0,0 +1,16 @@
|
||||
{
|
||||
"metering_labels": [
|
||||
{
|
||||
"tenant_id": "45345b0ee1ea477fac0f541b2cb79cd4",
|
||||
"description": "label1 description",
|
||||
"name": "label1",
|
||||
"id": "a6700594-5b7a-4105-8bfe-723b346ce866"
|
||||
},
|
||||
{
|
||||
"tenant_id": "45345b0ee1ea477fac0f541b2cb79cd4",
|
||||
"description": "label2 description",
|
||||
"name": "label2",
|
||||
"id": "e131d186-b02d-4c0b-83d5-0c0725c4f812"
|
||||
}
|
||||
]
|
||||
}
|
||||
443
v2.0/wadl/metering-labels.wadl
Normal file
443
v2.0/wadl/metering-labels.wadl
Normal file
@ -0,0 +1,443 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE application [<!ENTITY % common SYSTEM "../common.ent">
|
||||
%common;]>
|
||||
|
||||
<!-- (C) 2013 OpenStack Foundation, All Rights Reserved -->
|
||||
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:csapi="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:metering="http://docs.openstack.org/neutron/api/v2.0">
|
||||
<grammars>
|
||||
<include href="../xsd/metering.xsd"/>
|
||||
</grammars>
|
||||
<resources base="https://servers.api.openstack.com/">
|
||||
<resource id="version">
|
||||
<resource id="metering_labels" path="metering-labels">
|
||||
<method href="#listMeteringLabels"/>
|
||||
<method href="#createMeteringLabel"/>
|
||||
<resource id="get_metering_label"
|
||||
path="{metering_label_id}">
|
||||
<param name="metering_label_id" style="template"
|
||||
type="csapi:uuid">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">
|
||||
The unique identifier of the metering
|
||||
label. </p></doc>
|
||||
</param>
|
||||
<method href="#getMeteringLabel"/>
|
||||
<method href="#deleteMeteringLabel"/>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="metering_label_rules"
|
||||
path="metering-label-rules">
|
||||
<method href="#listMeteringLabelRules"/>
|
||||
<method href="#createMeteringLabelRule"/>
|
||||
<resource path="{metering-label-rule-id}">
|
||||
<param name="metering-label-rule-id"
|
||||
style="template" type="csapi:uuid">
|
||||
<doc><p xmlns="http://www.w3.org/1999/xhtml">
|
||||
The unique identifier of metering label rule.
|
||||
</p></doc>
|
||||
</param>
|
||||
<method href="#getMeteringLabelRule"/>
|
||||
<method href="#deleteMeteringLabelRule"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="GET" id="listMeteringLabels">
|
||||
<wadl:doc xml:lang="EN" title="List Metering Labels"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<para role="shortdesc">Lists a summary of all
|
||||
l3 metering labels belonging to the specified
|
||||
tenant.</para>
|
||||
<para>The list includes the unique ID for each metering
|
||||
labels.</para>
|
||||
<para>This operation does not require a request
|
||||
body.</para>
|
||||
<para>This operation returns a response body.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN"><xsdxt:code
|
||||
href="../samples/metering-labels-list-get-req.json"
|
||||
/></doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-labels-list-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="createMeteringLabel">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create Metering Label">
|
||||
<para role="shortdesc">Creates a l3 metering label.
|
||||
</para>
|
||||
<para>This operation requires a request body. </para>
|
||||
<para>The following table describes the required and
|
||||
optional attributes in the request body:</para>
|
||||
<table width="75%" rules="all"><caption>Create Metering Label
|
||||
Rule Request Attributes</caption>
|
||||
<thead><tr><th>Attribute</th><th>Required</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><para>name</para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para>The name of the metering label.
|
||||
</para></td></tr>
|
||||
<tr><td><para>description</para></td>
|
||||
<td><para>Optional</para></td><td><para>
|
||||
Description for the metering label.
|
||||
</para></td></tr>
|
||||
</tbody></table>
|
||||
<para>This operation returns a response body, which
|
||||
contains the following informations about the metering label:
|
||||
</para>
|
||||
<itemizedlist><listitem><para><code>name</code>.
|
||||
Name of the metering label.</para></listitem>
|
||||
<listitem><para><code>description</code>. Description of
|
||||
the metering label.</para></listitem>
|
||||
<listitem><para><code>tenant_id</code>. The tenant ID for the
|
||||
specified metering label.
|
||||
</para></listitem>
|
||||
<listitem><para><code>id</code>. The metering label ID
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-create-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-create-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="400"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:badRequest"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMeteringLabel">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show Metering Label">
|
||||
<para role="shortdesc">Shows informations for a specified
|
||||
metering label.</para>
|
||||
<para>This operation does not require a request
|
||||
body.</para>
|
||||
<para>This operation returns a response body that contains
|
||||
the description, name, ID.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-get-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="404"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:itemNotFound"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteMeteringLabel">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete Metering Label">
|
||||
<para role="shortdesc">Deletes a l3 metering label.
|
||||
</para>
|
||||
<para>This operation deletes a l3 metering label.
|
||||
</para>
|
||||
<para>This operation does not require a request body. This
|
||||
operation does not return a response body. </para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-delete-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-delete-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="404"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:itemNotFound"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listMeteringLabelRules">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List Metering Label Rules">
|
||||
<para role="shortdesc">Lists a summary of all
|
||||
l3 metering label rules belonging to the specified
|
||||
tenant.</para>
|
||||
<para>The list provides the unique ID for each metering
|
||||
label rule.</para>
|
||||
<para>This operation does not require a request body. This
|
||||
operation returns a response body. </para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rules-list-get-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rules-list-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="createMeteringLabelRule">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create Metering Label Rule">
|
||||
<para role="shortdesc">Creates a l3 metering label rule.
|
||||
</para>
|
||||
<para>This operation requires a request body. </para>
|
||||
<para>The following table describes the required and
|
||||
optional attributes in the request body:</para>
|
||||
<table width="75%" rules="all"><caption>Create Metering Label
|
||||
Rule Request Attributes</caption>
|
||||
<thead><tr><th>Attribute</th><th>Required</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><para>direction</para></td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>Ingress or egress: The direction in
|
||||
which metering rule is
|
||||
applied. Default: ingress
|
||||
</para></td></tr>
|
||||
<tr><td><para>metering_label_id</para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para>The meteting label ID to associate
|
||||
with this metering rule.
|
||||
</para></td></tr>
|
||||
<tr><td><para>excluded</para></td>
|
||||
<td><para>Optional</para></td><td><para>
|
||||
Specify whether the remote_ip_prefix will be
|
||||
excluded or not from traffic counters of the metering
|
||||
label, ie: to not count the traffic of a
|
||||
specific IP address of a range. Default: False
|
||||
</para></td></tr>
|
||||
<tr><td><para>remote_ip_prefix</para></td>
|
||||
<td><para>Required</para></td><td><para>The
|
||||
remote IP prefix to be associated with
|
||||
this metering rule.
|
||||
packet.</para></td></tr></tbody></table>
|
||||
<para>This operation returns a response body. </para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rule-create-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rule-create-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="400"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:badRequest"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="404"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:itemNotFound"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="409"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:buildInProgress"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getMeteringLabelRule">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Show Metering Label Rule">
|
||||
<para role="shortdesc">Shows detailed informations for a
|
||||
specified metering label rule.</para>
|
||||
<para>This operation does not require a request
|
||||
body.</para>
|
||||
<para>This operation returns a response body, which
|
||||
contains the following informations about the metering label
|
||||
rule:</para>
|
||||
<itemizedlist><listitem><para><code>direction</code>.
|
||||
Either ingress or egress.</para></listitem>
|
||||
<listitem><para><code>excluded</code>. Either True or
|
||||
False.</para></listitem>
|
||||
<listitem><para>The ID for the specified metering label
|
||||
rule</para></listitem>
|
||||
<listitem><para>The remote IP prefix</para></listitem>
|
||||
<listitem><para>The metering label ID for the metering label
|
||||
with which the rule is associated</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rule-get-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rule-get-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="404"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:itemNotFound"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteMeteringLabelRule">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete Metering Label Rule">
|
||||
<para role="shortdesc">Deletes a specified l3 metering label rule.
|
||||
</para>
|
||||
<para>This operation does not require a request
|
||||
body.</para>
|
||||
<para>This operation does not return a response body.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rule-delete-req.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="204">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<xsdxt:code
|
||||
href="../samples/metering-label-rule-delete-resp.json"
|
||||
/>
|
||||
</doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="401"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:unauthorized"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
<response status="404"
|
||||
xmlns="http://wadl.dev.java.net/2009/02">
|
||||
<representation mediaType="application/xml"
|
||||
element="metering:itemNotFound"/>
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
</method>
|
||||
</application>
|
||||
Loading…
x
Reference in New Issue
Block a user