Overview
The node interacts with the OpenSearch API, allowing users to manage and query OpenSearch indices and documents. It supports operations such as retrieving multiple indices or documents, creating, updating, and deleting them. This node is beneficial for scenarios where you need to automate search index management or perform bulk document queries and updates within OpenSearch clusters.
For example, you can use this node to:
- Retrieve a list of all indices in your OpenSearch cluster.
- Fetch many documents from a specific index with optional filtering.
- Create or update documents programmatically based on incoming data.
- Delete documents or entire indices as part of cleanup workflows.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return when "Return All" is false (minimum 1). |
These properties apply specifically to the Index - Get Many operation, controlling how many index entries are retrieved.
Output
The output is a JSON array where each item represents an index object with at least one property:
indexId: The identifier/name of the index.
When fetching many indices, the node returns an array of objects each containing the indexId field representing individual indices found in the OpenSearch cluster.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the OpenSearch API.
- The node depends on internal helper functions to make HTTP requests to OpenSearch endpoints.
- No additional external services beyond OpenSearch itself are required.
Troubleshooting
Common issues:
- Authentication failures due to invalid or missing API credentials.
- Request limits exceeded if too many items are requested without enabling pagination or limiting results.
- Malformed query parameters causing JSON parsing errors.
Error messages:
- Errors returned from OpenSearch API calls will include error type and reason. For example, "index_not_found_exception" if the specified index does not exist.
- If bulk operations fail, the node throws an error with details about which item caused the failure.
Resolutions:
- Verify that the API key credential is correctly configured and has sufficient permissions.
- Use the "Limit" property to restrict the number of results or enable "Return All" carefully.
- Check the correctness of any JSON query strings or options provided.