Skip to main content
Version: 2.3

Rate limits

note

Rate limits are currently available as a preview feature and are under development. See Preview features.

If you use the rate limit feature and have feedback to share, contact us.
You must enable this feature in the application properties file to use it.

Data Migrator allows you to manage resources by limiting the number of calls Hive Migrator can make simultaneously in your environment.

How it works​

You can specify the number of requests that can be made within a time period for a specific agent, or all agents configured for a product instance.

CLI commands​

Parameters​

  • --name The name of the agent for which you want to set a rate limit.
  • --calls Defines the number of calls in a time period for a rate limit.
  • --period Defines the time period for a rate limit as an ISO-formatted duration.

Set a rate limit​

Set a rate limit for a specific agent by using hive agent set rate limit.

Set a rate limit
hive agent set rate limit   [--name] string  
                            [--calls] int
                            [--period] string
Example: Set a rate limit for an agent​
Set a rate limit of 10 calls per minute for agent1
hive agent set rate limit --name agent1 --calls 10 --period PT1M

Set a rate limit for all agents​

Set a rate limit for all agents by using hive agent set rate limit all.

Set a rate limit for all agents
hive agent set rate limit all   [--calls] int
                                [--period] string
Example: Set a rate limit for all agents​
Set a rate limit of 60 calls per 5 minutes for all agents
hive agent set rate limit all --calls 60 --period PT5M

Remove a rate limit​

Remove an existing rate limit for a specific agent by using hive agent remove rate limit.

Remove an existing rate limit for an agent
hive agent remove rate limit   [--name] string
Example: Remove a rate limit​
Remove an existing rate limit for agent1
hive agent set rate limit --name agent1

Show a rate limit​

Show an existing rate limit for a specific agent by using hive agent show rate limit.

Show an existing rate limit for an agent
hive agent show rate limit    [--name] string
Example: Show a rate limit​
Show an existing rate limit for agent1
hive agent show rate limit --name agent1