Personal tools

From HEXONET Wiki

Jump to: navigation, search
(Created page with "{{Sidebar}} __NOTOC__ == System Usage Restrictions == To save the security and availability of our network resources, HEXONET users are not allowed to send an unlimited amou...")
 
m (Wording)
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Sidebar}}
+
{{Sidebar}}__NOTOC__
__NOTOC__
+
 
+
 
== System Usage Restrictions ==
 
== System Usage Restrictions ==
  
To save the security and availability of our network resources, HEXONET users are not allowed to send an unlimited amount of API requests within a too short time. To regulate the amount of allowed requests, we use a quota system, which regulates the API connection by using quota points
+
To increase the security and save availability of our network resources, HEXONET users are only allowed to send a limited amount of API requests in a short time period. To regulate the amount of allowed requests we use a quota system, which regulates the API connection by using quota points.
  
 
=== Commands adding quota points ===
 
=== Commands adding quota points ===
  
Currently, the following commands are adding quota points to the user account of the user executing them:
+
Currently, the following commands will add quota points to the user account of the user executing them:
  
 
* [[API:CheckDomain | CheckDomain]]: 1 point
 
* [[API:CheckDomain | CheckDomain]]: 1 point
Line 36: Line 34:
 
=== Reducing quota points ===
 
=== Reducing quota points ===
  
The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied with 0.8, meaning that your quota point amount gets reduced by 20 % every minute.
+
The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied by 0.8, meaning that your quota point amount gets reduced by 20% every minute.
  
 
=== Quota related XIRCA user relations ===
 
=== Quota related XIRCA user relations ===
  
The following [[XIRCA_User_Relations|XIRCA user relations]] exist to use the quota system:
+
The following XIRCA user relations exist to use the quota system:
  
 
===== quota for domain related commands: =====
 
===== quota for domain related commands: =====
<pre>SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA</pre> = (INTEGER)
+
<pre>SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA = (INTEGER)</pre>
<pre>SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA</pre> = (INTEGER)
+
<pre>SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA = (INTEGER)</pre>
  
 
===== common system quota (currently not used): =====
 
===== common system quota (currently not used): =====
<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA</pre> = (INTEGER)
+
<pre>SERVICE_USAGE_SYSTEM_HARDQUOTA = (INTEGER)</pre>
<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA</pre> = (INTEGER)
+
<pre>SERVICE_USAGE_SYSTEM_SOFTQUOTA = (INTEGER)</pre>

Revision as of 17:25, 4 September 2015

System Usage Restrictions

To increase the security and save availability of our network resources, HEXONET users are only allowed to send a limited amount of API requests in a short time period. To regulate the amount of allowed requests we use a quota system, which regulates the API connection by using quota points.

Commands adding quota points

Currently, the following commands will add quota points to the user account of the user executing them:

  • CheckDomainApplication: 1 point


Soft and hard quota marks

Every HEXONET account has a

  • soft quota mark (300 points by default)
  • hard quota mark (500 points by default)


If the soft quota mark is reached, the system responses will get a delay of 5 seconds. That means that the response time is slowed down so that the user recognizes that he may sent too many requests within a short time.

If an account reached the hard quota mark, the account will get temporarily locked and the system will respond "Service temporarily locked; usage exceeded". Further API requests will not be accepted and will be answered with this message, although they keep increasing the quota points!

Reducing quota points

The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied by 0.8, meaning that your quota point amount gets reduced by 20% every minute.

Quota related XIRCA user relations

The following XIRCA user relations exist to use the quota system:

quota for domain related commands:
SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA = (INTEGER)
SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA = (INTEGER)
common system quota (currently not used):
SERVICE_USAGE_SYSTEM_HARDQUOTA = (INTEGER)
SERVICE_USAGE_SYSTEM_SOFTQUOTA = (INTEGER)