How Load Balancing Works (Smart 3D Admin web API Only) - Intergraph Smart 3D Web API - Installation & Upgrade - Hexagon

Intergraph Smart 3D and Smart 3D Admin Web API Installation and Configuration

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Installation & Upgrade
Smart 3D Version
13.1

The Smart 3D Admin web API workload is balanced by starting and stopping service instances on each machine. There can be multiple service instances in an environment, including:

  • Default admin service instance - There is a single default admin service for each configured instance of the API.

  • Dedicated service instances - There is a single separate, dedicated service instance for each site and each plant enabled for use with the Smart 3D Admin Web API.

  • Dedicated service instances for the Catalog Customization workflow - There is a separate, dedicated service instance for each combination of site and shared content path. This improves performance and delivers more consistent results.

    To use this service, you must call the EnablePlant or EnablePlants action for all plants that are part of the Catalog Customization workflow.

Both default and dedicated service instances run continuously.

How the system balances the load

When a service instance is first created, the system automatically assigns the instance to a machine. The assignment is based on load balancing, which is computed based the number of cores available on each machine.

Changes that affect load balancing

You can change where service instances are running by:

  • Adding a machine to the configuration - When you add a machine, the system automatically reassigns service instances to the new machine, especially those service instances assigned to machines that are considered overloaded. For instructions, see Get started.

  • Removing a machine from the configuration - When you remove a machine, the system automatically reassigns the service instances it was running to other machines in the configuration. For instructions, see Review machine configuration for the Smart 3D Admin web API.

You cannot manually add, remove or reassign service instances.