Overview
This node interacts with the NATS JetStream Key-Value (KV) Store, specifically managing KV buckets and keys within those buckets. The "Get Status" operation for a bucket retrieves the current status or metadata of a specified KV bucket. This is useful for monitoring or verifying the existence and configuration of a bucket before performing further operations such as adding or retrieving keys.
Practical examples include:
- Checking if a bucket exists and is properly configured before writing data.
- Retrieving metadata about a bucket to audit its settings.
- Monitoring bucket health or status in automated workflows.
Properties
| Name | Meaning |
|---|---|
| Bucket Name | The name of the KV bucket to operate on. Bucket names can only contain alphanumeric characters, dashes, and underscores. |
Output
The output JSON contains the status information of the specified KV bucket. This typically includes metadata such as bucket configuration details, creation time, and other relevant status indicators provided by the NATS JetStream KV API.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a NATS JetStream server with access to the KV store feature.
- Requires an API key credential for authenticating with the NATS server.
- Uses the
nats-bundledlibrary internally to interact with the NATS JetStream KV API. - Proper n8n credentials setup for the NATS API authentication is necessary.
Troubleshooting
- Invalid Bucket Name: If the bucket name contains invalid characters, the node will throw an error. Ensure bucket names only use alphanumeric characters, dashes, and underscores.
- Unknown Operation Error: If the operation name is incorrect or unsupported, the node will report an unknown operation error.
- Connection Issues: Failure to connect to the NATS server due to incorrect credentials or network issues will cause errors. Verify credentials and network connectivity.
- Bucket Not Found: If the specified bucket does not exist, the node may return an error or empty status. Confirm the bucket exists on the NATS server.