Skip to content

Commit 5924f95

Browse files
authored
Merge pull request #175783 from jakrams/user/jakras/rest
Add information about REST call delay
2 parents 581c0ac + 004a502 commit 5924f95

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

articles/remote-rendering/how-tos/frontend-apis.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ In this section, we will describe how to use the API for authentication and sess
1515
> [!CAUTION]
1616
> The functions described in this chapter issue REST calls on the server internally. As for all REST calls, sending these commands too frequently will cause the server to throttle and return failure eventually. The value of the `SessionGeneralContext.HttpResponseCode` member in this case is 429 ("too many requests"). As a rule of thumb, there should be a delay of **5-10 seconds between subsequent calls**.
1717
18+
Some functions also return information when it is save to retry. For example `RenderingSessionPropertiesResult.MinimumRetryDelay` specifies how many seconds to wait before attempting another check. When available, using such a returned value is best, as it allows you to do checks as often as possible, without getting throttled.
1819

1920
## SessionConfiguration
2021

articles/remote-rendering/resources/troubleshoot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ If you are working on a laptop with two GPUs, it is possible that the GPU you ar
3232

3333
## Retrieve session/conversion status fails
3434

35-
Sending REST API commands too frequently will cause the server to throttle and return failure eventually. The http status code in the throttling case is 429 ("too many requests"). As a rule of thumb, there should be a delay of **5-10 seconds between subsequent calls**.
35+
Sending REST API commands too frequently will cause the server to throttle and return failure eventually. The HTTP status code in the throttling case is 429 ("too many requests"). As a rule of thumb, there should be a delay of **5-10 seconds between subsequent calls**.
3636

37-
Note this limit not only affects the REST API calls when called directly but also their C#/C++ counterparts, such as `Session.GetPropertiesAsync`, `Session.RenewAsync`, or `Frontend.GetAssetConversionStatusAsync`.
37+
Note this limit not only affects the REST API calls when called directly but also their C#/C++ counterparts, such as `Session.GetPropertiesAsync`, `Session.RenewAsync`, or `Frontend.GetAssetConversionStatusAsync`. Some functions also return information when it is save to retry. For example `RenderingSessionPropertiesResult.MinimumRetryDelay` specifies how many seconds to wait before attempting another check. When available, using such a returned value is best, as it allows you to do checks as often as possible, without getting throttled.
3838

3939
If you experience server-side throttling, change the code to do the calls less frequently. The server will reset the throttling state every minute, so it is safe to rerun the code after a minute.
4040

articles/remote-rendering/samples/powershell-example-scripts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The [ARR samples repository](https://github.com/Azure/azure-remote-rendering) co
2121
> There is also a [UI-based tool called ARRT](azure-remote-rendering-asset-tool.md) to interact with the service, which is a convenient alternative to using scripts. ![ARRT](./media/azure-remote-rendering-asset-tool.png "ARRT screenshot")
2222
2323
> [!CAUTION]
24-
> Calling REST API functions too frequently will cause the server to throttle and return failure eventually. The http failure code id in this case is 429 ("too many requests"). As a rule of thumb, there should be a delay of **5-10 seconds between subsequent calls**.
24+
> Calling REST API functions too frequently will cause the server to throttle and return failure eventually. The HTTP failure code id in this case is 429 ("too many requests"). As a rule of thumb, there should be a delay of **5-10 seconds between subsequent calls**.
2525
2626
## Prerequisites
2727

0 commit comments

Comments
 (0)