PL 400 : implement API limit retry policies (Use platform APIs)

API limits act as guardian to control random and unpredictable surges in API request volume. A large number of requests create availability problems and reduce performance, in other words, API limits ensure the health and accessibility of the API. With HTTP API requests, this error usually appears as a response with a 429 status code. It also sends additional information to indicate the time required to wait until another request is attempted. This header is usually called "Retry-After".


Dataverse API limits help ensure service level, availability, and quality. Dataverse API limits are part of the Power Platform request limit and allocation. There are two categories of limits that apply for Dataverse.

  • Entitlement limits
  • Service Protection limits
Entitlement limits:

Entitlement limits are associated with type of license assigned to each user. If user exceeds their requests, the administrator would be notified.

Service Protection limits:

To maintain the performance and availability, Microsoft applies some limits on Dataverse API usages. Such limitations only effect to large number of API requests to prevent to surge the unexpected and random requests. The limit also apply on concurrent connection per user account, the number of API request per connection, and the amount of execution time. When one of these limits is exceeded an exception will be thrown by the platform.

Service protection limits apply to all external web service requests.

Microsoft always recommends to apply patterns to retry operations after a period of time when these exception are returned. These limits are designed to detect when client applications are making extraordinary demands on server resources.

The limit doesn't effect the normal users of interactive clients.

Plug-ins and custom workflow activities implement business logic triggered by incoming requests. Service security limits do not apply to plug-ins and custom workflow activities. Plug-ins and custom workflow activities are uploaded and run within an isolated sandbox service. Dataverse operations implemented on a sandbox service do not use a public API endpoint.

Retry Operation:

When a Service protection  API limit error occurs, it will provide a value indicating the length of time before any new requests from the user are processed.
  • When a 429 error is returned from the Web API, the response will include a Retry-After with number of seconds.
  • With OrganizationService, a TimeSpan value is returned in the OrganizationServiceFault.ErrorDetails collection with the key Retry-After.
In an interactive application re-try, the developer should display a message that the server is busy while the user retry the request made by the user and try again in a non-interactive application re-try, leaving the client application to simply wait before the period elapses. Must practice is sending request again.

The service protection API limits are evaluated per user.

Service protection API limits are enforced based on three facets:
  • The number of requests sent by a user.
  • The combined execution time required to process requests sent by a user.
  • The number of concurrent requests sent by a user.


The availability of servers depends on multiple factors, but each web server of environment will enforce these limits independently. As known, most environment will have more than one web server. Trial environments are allocated only a single web server.

The Retry-After duration will depend on the nature of the operations that have been sent in the preceding 5 minute period.

Conclusion:

The API limit does not impose any restrictions in use, obviously, it helps to increase performance and availability for all. Sometimes, developers write code without reading the documentation or unintentionally misuse the resource consumption, such limit prevents such incidents. Microsoft provides unlimited resources for commercial use, but also implements mechanisms that help use the Dataverse API in customizable ways.

Comments

Post a Comment

Popular posts from this blog

Exploring the Differences: Managed vs. Unmanaged Solutions in Dynamics CRM/Dataverse

Image
In Dynamics CRM/Dataverse, solutions are central to Application Lifecycle Management (ALM) , providing a structured way to manage, package, and distribute customizations across environments. Microsoft uses solutions to transfer apps and customizations by exporting them from one Dataverse environment and importing them into another.  Each solution is authored and maintained by a publisher and includes components like Power Apps (canvas and model-driven), flows, entities, forms, connectors, web resources, and configurations—excluding business data. Solutions streamline ALM practices within Microsoft Power Platform. In Dynamics CRM/Dataverse, there are two types of solutions: Managed and Unmanaged . When planning an implementation, it’s important to understand the advantages and disadvantages of each to make an informed decision. Let’s explore both types to determine the best approach for development and deployment. In Dynamics 365 CRM, a managed solution is a fully packaged solution ...
Read more

PCF vs. Web Resources: Choosing the Right Extensibility Tool for Dataverse

Image
Extensibility refers to the ability to be extended or augmented beyond the default capabilities of the platform. This involves customization but also includes more advanced techniques, such as coding, integration with external services, and the use of custom components. In the context of Power Platform and Dynamics CRM, the term "extend behavior" refers to the ability to customize and extend the functionality of the platform to meet specific business needs. Extensibility often requires technical skills, such as coding in JavaScript, C#, or using tools like Azure Logic Apps and Power Automate for complex integrations. Customization  is a subset of extensibility. Customization involves configuring and modifying existing elements within the platform to suit specific business needs. Extensibility, on the other hand, covers a wide range of functions and techniques, including customization and more advanced development and integration tasks, to extend the capabilities of the Power ...
Read more

Effective Strategies for Debugging Plugins in Dynamics CRM

Image
In a recent interview, I was asked about debugging plugins in Dynamics CRM. The interviewer specifically wanted to know my approach to plugin debugging. In response, I mentioned using the Plugin Registration Tool profiler. However, I later realized there are multiple methods to debug plugins in Dynamics CRM/Dataverse, each essential for efficient troubleshooting. Debugging plays a crucial role in development, and having a solid understanding of various debugging approaches can help streamline issue resolution in Dynamics 365. Here, I'll explore different techniques for debugging plugin code. There are below options to use in the plugin in Dynamics CRM/Dataverse ITracingService : In Dynamics CRM plugin development, ITracingService is a service provided within the plugin's execution context that logs information for tracing and debugging. It allows developers to capture real-time. Plugin Profiler : A plugin profiler in Dynamics CRM (or Dataverse) is a debugging tool in the Plugi...
Read more