openstack/api-site
Code Issues Proposed changes

Merge "Add definitions of absolute and rate limits."

Browse Source
This commit is contained in:
Jenkins 2015-04-05 00:44:05 +00:00 committed by Gerrit Code Review
commit e74b1b15c9
4 changed files with 253 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

225
api-ref/src/wadls/compute-api/src/v2/common.ent
View File

@ -1781,3 +1781,228 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY absoluteLimits '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxImageMeta" style="plain" required="true"
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 key-value pairs per image for the
project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxPersonality" style="plain" required="true"
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 file path and content pairs that can be
supplied on server build and rebuild for the project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxPersonalitySize" style="plain" required="true"
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 size, in bytes, for each personality file that is
guaranteed to apply to all images in the project. Providers can
set additional per-image personality limits.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxSecurityGroupRules" style="plain" required="true"
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 security group rules per security group for
the project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxSecurityGroups" style="plain" required="true"
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 security groups per server for the project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxServerMeta" style="plain" required="true"
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 metadata key-value pairs that can be supplied
per server for the project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxTotalCores" style="plain" required="true"
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 cores for the project.</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxTotalFloatingIps" style="plain" required="true"
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 floating IP addresses for the project.
</para>
<para>
These IPs must be allocated from the central pool before they can
be used. To allocate a floating IP to a project, see <link
xlink:href="http://docs.openstack.org/user-guide/content/floating_ip_allocate.html">Associate floating IP
addresses</link>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxTotalInstances" style="plain" required="true"
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 servers at any one time for the project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxTotalKeypairs" style="plain" required="true"
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 key pairs per server for the project.</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxTotalRAMSize" style="plain" required="true"
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 total amount of RAM, in MB, for all servers at any one
time for the project.
</para>
</wadl:doc>
</param><param xmlns="http://wadl.dev.java.net/2009/02"
name="maxServerGroups" style="plain" required="true"
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 maximun number of server groups per server for the project.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="maxServerGroupMembers" style="plain" required="true"
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 server group members per server group for the project.
</para>
</wadl:doc>
</param>'>
<!ENTITY totalUsedLimits '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="totalCoresUsed" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Total cores used.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="totalInstancesUsed" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Total instances used.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="totalRAMUsed" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Total RAM, in MB, used for all servers at any one
time.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="totalSecurityGroupsUsed" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Total security groups used.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="totalCoresUsed" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Total cores used.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="totalFloatingIpsUsed" style="plain" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Total floating IP addresses used.
</para>
</wadl:doc>
</param>'>
<!ENTITY rateLimits '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rate" style="plain" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Current rate limits.
</para>
</wadl:doc>
</param>'>

16
api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl
View File

@ -1,10 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-used-limits-for-admins-v2">
<resource id="version" path="//v2">
@ -61,6 +68,7 @@
href="../api_samples/os-used-limits-for-admin/usedlimitsforadmin-get-resp.xml"
/>
</wadl:doc>
&absoluteLimits; &totalUsedLimits; &rateLimits;
</representation>
</response>
</method>

16
api-ref/src/wadls/compute-api/src/v2/ext/os-used-limits.wadl
View File

@ -1,10 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
<application xmlns="http://wadl.dev.java.net/2009/02"
<!DOCTYPE application [
<!ENTITY % common SYSTEM "../common.ent">
%common;
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
%common_project;
]>
<application xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://docs.rackspacecloud.com/xsd/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:db="http://docbook.org/ns/docbook"
xmlns:common="http://docs.openstack.org/common/api/v1.0"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com"
xml:id="os-used-limits-v2">
<resource id="version" path="//v2">
@ -45,6 +52,7 @@
href="../api_samples/os-used-limits/usedlimits-get-resp.xml"
/>
</wadl:doc>
&absoluteLimits; &totalUsedLimits; &rateLimits;
</representation>
</response>
</method>

5
api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
View File

@ -278,7 +278,9 @@
<!-- Limits -->
<method name="GET" id="listLimits">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List limits">
<para role="shortdesc">Lists the current limits for the account.</para>
<para role="shortdesc">
Lists the current absolute and rate limits for a specified project.
</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
@ -290,6 +292,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="../api_samples/limit-get-resp.xml"/>
</wadl:doc>
&absoluteLimits; &rateLimits;
</representation>
</response>
<!-- Common Faults and Header --> &commonFaults; </method>