|
| 1 | +--- |
| 2 | +title: API throttling guidance for customers using Azure Data Manager for Agriculture. |
| 3 | +description: Provides information on API throttling limits to plan usage. |
| 4 | +author: gourdsay |
| 5 | +ms.author: angour |
| 6 | +ms.service: data-manager-for-agri |
| 7 | +ms.topic: conceptual |
| 8 | +ms.date: 04/18/2023 |
| 9 | +ms.custom: template-concept |
| 10 | +--- |
| 11 | + |
| 12 | +# API throttling guidance for Azure Data Manager for Agriculture. |
| 13 | + |
| 14 | +The API throttling in Azure Data Manager for Agriculture allows more consistent performance within a time span for customers calling our service APIs. Throttling limits, the number of requests to our service in a time span to prevent overuse of resources. Azure Data Manager for Agriculture is designed to handle a high volume of requests, if an overwhelming number of requests occur by few customers, throttling helps maintain optimal performance and reliability for all customers. |
| 15 | + |
| 16 | +Throttling limits vary based on product type and capabilities being used. Currently we have two versions, standard and basic (for your POC needs). |
| 17 | + |
| 18 | +## DPS API limits |
| 19 | + |
| 20 | +Throttling category | Units available per Standard version| Units available per Basic version | |
| 21 | +|:------|:------|:------| |
| 22 | +Per Minute | 25,000 | 25,000 | |
| 23 | +Per 5 Minutes| 100,000| 100,000 | |
| 24 | +Per Month| 25,000,000| 5,000,000| |
| 25 | + |
| 26 | +### Maximum requests allowed per type for standard version |
| 27 | +API Type| Per minute| Per 5 minutes| Per month| |
| 28 | +|:------|:------|:------|:------| |
| 29 | +PUT |5,000 |20,000 |5,000,000 |
| 30 | +PATCH |5,000 |20,000 |5,000,000 |
| 31 | +POST |5,000 |20,000 |5,000,000 |
| 32 | +DELETE |5,000 |20,000 |5,000,000 |
| 33 | +GET (single object) |25,000 |100,000 |25,000,000 |
| 34 | +LIST with paginated response |25,000 results |100,000 results |25,000,000 results |
| 35 | + |
| 36 | +### Maximum requests allowed per type for basic version |
| 37 | +API Type| Per minute| Per 5 minutes| Per month| |
| 38 | +|:------|:------|:------|:------| |
| 39 | +PUT |5,000 |20,000 |1,000,000 |
| 40 | +PATCH |5,000 |20,000 |1,000,000 |
| 41 | +POST |5,000 |20,000 |1,000,000 |
| 42 | +DELETE |5,000 |20,000 |1,000,000 |
| 43 | +GET (single object) |25,000 |100,000 |5,000,000 |
| 44 | +LIST with paginated response |25,000 results |100,000 results |5,000,000 results |
| 45 | + |
| 46 | +### Throttling cost by API type |
| 47 | +API Type| Cost per request| |
| 48 | +|:------|:------:| |
| 49 | +PUT |5 |
| 50 | +PATCH |5 |
| 51 | +POST |5 |
| 52 | +DELETE |5 |
| 53 | +GET (single object) |1 |
| 54 | +GET Sensor Events |1 + 0.01 per result |
| 55 | +LIST with paginated response |1 per request + 1 per result |
| 56 | + |
| 57 | +## Jobs create limits per instance of our service |
| 58 | +The maximum queue size for each job type is 10,000. |
| 59 | + |
| 60 | +### Total units available |
| 61 | +Throttling category| Units available per Standard version| Units available per Basic version| |
| 62 | +|:------|:------|:------| |
| 63 | +Per 5 Minutes |1,000 |1,000 |
| 64 | +Per Month |1,000,000 |200,000 |
| 65 | + |
| 66 | + |
| 67 | +### Maximum create job requests allowed for standard version |
| 68 | +Job Type| Per 5 mins| Per month| |
| 69 | +|:------|:------|:------| |
| 70 | +Cascade delete| 1,000| 500,000 |
| 71 | +Satellite| 1,000| 500,000 |
| 72 | +Model inference| 200| 100,000 |
| 73 | +Farm Operation| 200| 100,000 |
| 74 | +Rasterize| 500| 250,000 |
| 75 | +Weather| 500| 250,000 |
| 76 | + |
| 77 | + |
| 78 | +### Maximum create job requests allowed for basic version |
| 79 | +Job Type| Per 5 mins| Per month |
| 80 | +|:------|:------|:------| |
| 81 | +Cascade delete| 1,000| 100,000 |
| 82 | +Satellite| 1,000| 100,000 |
| 83 | +Model inference| 200| 20,000 |
| 84 | +Farm Operation| 200| 20,000 |
| 85 | +Rasterize| 500| 50,000 |
| 86 | +Weather| 500| 50,000 |
| 87 | + |
| 88 | +### Sensor events limits |
| 89 | +100,000 event ingestion per hour by our sensor job. |
| 90 | + |
| 91 | +## Error code |
| 92 | +When you reach the limit, you receive the HTTP status code **429 Too many requests**. The response includes a **Retry-After** value, which specifies the number of seconds your application should wait (or sleep) before sending the next request. If you send a request before the retry value has elapsed, your request isn't processed and a new retry value is returned. |
| 93 | + |
| 94 | +After waiting for specified time, you can also close and reopen your connection to Azure Data Manager for Agriculture. |
| 95 | + |
| 96 | +## Next steps |
| 97 | +* See the Hierarchy Model and learn how to create and organize your agriculture data [here](./concepts-hierarchy-model.md). |
| 98 | +* Understand our APIs [here](/rest/api/data-manager-for-agri). |
0 commit comments