ScrapybaraInstall

Overview

This node integrates with the Scrapybara API to manage and interact with virtual instances. Specifically, the "Stop" operation for the "Instance" resource allows users to stop a running instance by specifying its ID. This is useful in scenarios where you want to programmatically control the lifecycle of cloud or virtual machine instances, such as shutting down test environments after use to save resources or stopping instances that are no longer needed.

Practical examples include:

• Automatically stopping an instance after completing a workflow.
• Managing instance states in automated testing pipelines.
• Controlling costs by terminating idle or completed instances.

Properties

Output

The output JSON contains the following fields:

• success: A boolean indicating whether the stop operation was successful.
• instanceId: The ID of the instance that was requested to be stopped.

Example output JSON:

{
  "success": true,
  "instanceId": "your-instance-id"
}

If the operation fails, an error will be thrown with a message indicating the failure reason.

Dependencies

• Requires an API key credential for authenticating with the Scrapybara API.
• The node uses the scrapybara npm package internally to communicate with the API.
• Proper network access to the Scrapybara service endpoint is necessary.

Troubleshooting

• Common issues:

  • Invalid or missing Instance ID: Ensure the Instance ID provided exists and is correct.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network connectivity problems: Confirm that your environment can reach the Scrapybara API endpoints.

• Error messages:

  • Failed to stop instance <ID>: <error message>: Indicates the stop request failed on the API side. Check if the instance ID is correct and the instance is in a stoppable state.
  • Credential-related errors: Usually indicate invalid or missing API keys; reconfigure credentials accordingly.

Links and References

• Scrapybara API Documentation (hypothetical link)
• Scrapybara npm package