Blocklet Service icon

Blocklet Service

Consume Blocklet Service API

Overview

The node interacts with the Blocklet Service API, specifically supporting operations on various resources including Blocklets, Users, Tags, and Passports. For the Blocklet resource with the Get Blocklet operation, it retrieves detailed information about a blocklet instance.

This node is useful when you want to programmatically fetch metadata or status information about a blocklet within an automation workflow. For example, you might use it to monitor the state of a blocklet, gather runtime or disk usage info, or retrieve optional components associated with the blocklet for further processing or decision-making in your workflow.

Properties

Name Meaning
Attach Runtime Info Whether to include runtime information of the blocklet in the response (true/false).
Attach Disk Info Whether to include disk usage information of the blocklet in the response (true/false).
Get Optional Components Whether to retrieve optional components related to the blocklet (true/false).

These boolean properties allow you to customize the detail level of the blocklet data returned by the node.

Output

  • The output is a JSON array where each item corresponds to one input item processed.
  • Each JSON object contains the blocklet data retrieved from the Blocklet Service API.
  • The structure includes standard blocklet details and optionally includes runtime info, disk info, and optional components depending on the input properties set.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Blocklet Service API.
  • The node depends on the blockletServiceApiRequest function internally to make HTTP requests to the Blocklet Service.
  • No additional external services are required beyond the Blocklet Service itself.

Troubleshooting

  • Common issues:

    • Authentication failures if the API key credential is missing or invalid.
    • Network errors if the Blocklet Service API endpoint is unreachable.
    • Errors if unsupported operations or resources are selected.
  • Error messages:

    • "Not implemented blocklet action: <operation>" indicates that the requested operation is not supported by the node.
    • API error messages from the Blocklet Service will be propagated; ensure the parameters are correct and the service is available.
  • Resolutions:

    • Verify API credentials and permissions.
    • Confirm network connectivity to the Blocklet Service.
    • Use only supported operations and resources as defined by the node.

Links and References

Discussion