Actions27
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
Clusters → Get migration and user mapping status
AI-generatedOverview
This node operation retrieves the status of migration and user mapping processes in a multi-cluster setup. It is useful for monitoring the progress of time-consuming tasks such as creating large batches of users or migrating users between clusters. For example, it can be used to check if a user migration process has completed before proceeding with further actions.
Use Case Examples
- Check the migration status of user mappings in a multi-cluster Algolia setup to ensure data consistency before running queries.
- Monitor the progress of batch user creation across clusters to trigger notifications or subsequent workflows.
Properties
| Name | Meaning |
|---|---|
| Options | Optional parameters to include additional data in the response, such as the cluster's pending mapping state. |
Output
JSON
status- The current status of the migration or user mapping process.clusters- Details about clusters involved, including their pending mapping states if requested.
Dependencies
- An API key credential for authenticating requests to the Algolia service.
Troubleshooting
- Ensure the API key has the necessary permissions to access cluster mapping status endpoints.
- If the response is empty or incomplete, verify that the 'Get Clusters' option is set correctly according to your needs.
- Network issues or incorrect base URL configuration can cause request failures; check connectivity and credentials.
Links
- Algolia Clusters API - Get Migration and User Mapping Status - Official Algolia API documentation for retrieving migration and user mapping status in clusters.