Portainer icon

Portainer

Trabalhe com dados da API do Portainer para gerenciar Docker

Overview

This node integrates with the Portainer API to manage edge computing stacks, specifically allowing users to retrieve the deployment status of an Edge Stack. It is useful in scenarios where you need to monitor or verify the current state of an Edge Stack deployment within a Portainer-managed environment.

For example, after deploying or updating an Edge Stack, you can use this node operation to check if the deployment was successful, if it is still in progress, or if there are any errors reported by the system.

Properties

Name Meaning
Edge Stack ID The unique identifier of the edge stack whose status you want to retrieve.

Output

The node outputs JSON data representing the status of the specified Edge Stack deployment. This typically includes information about the deployment state, any errors, and possibly details about the edge groups involved.

The output JSON structure corresponds directly to the response from the Portainer API endpoint /edge_stacks/{edgeStackId}/status.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node expects the base URL of the Portainer API to be configured in the credentials.
  • Network access to the Portainer API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing Edge Stack ID will cause the API request to fail.
    • Incorrect or expired API key credential may result in authentication errors.
    • Network connectivity issues to the Portainer server will prevent the node from retrieving data.
  • Error Messages:

    • 404 Not Found: The specified Edge Stack ID does not exist. Verify the ID is correct.
    • 401 Unauthorized: Authentication failed due to invalid API key. Check your credentials.
    • 500 Internal Server Error: An issue occurred on the Portainer server. Retry later or check server logs.

Links and References

Discussion