Overview

This node operation retrieves detailed information about a specific Docker Swarm service within a given environment in Portainer. It is useful for users who want to fetch the current state, configuration, and metadata of a Docker Swarm service by specifying the environment and service IDs. For example, it can be used to monitor service status or inspect service details for management or automation purposes.

Use Case Examples

1. Fetch details of a Docker Swarm service by providing the environment ID and the service ID to monitor its configuration and status.
2. Use it in workflows that require service inspection before performing updates or scaling operations.

Properties

Output

JSON

• id - The unique identifier of the Docker Swarm service.
• name - The name of the Docker Swarm service.
• spec - The specification object describing the service configuration, including task template, mode, and endpoint specifications.
• updateStatus - Status information about the last update operation on the service.
• endpoint - Details about the service endpoint, including ports and virtual IPs.
• version - The version object representing the current version of the service for concurrency control.

Dependencies

• Portainer API with an API key credential for authentication

Troubleshooting

• Ensure the Environment ID and Service ID are correct and correspond to existing resources in Portainer.
• Check that the API key credential has sufficient permissions to access service details.
• If SSL issues occur, consider enabling the 'Ignore SSL Issues' option if appropriate for your environment.
• Verify network connectivity and proxy settings if requests fail or time out.

Links

• Portainer API - Docker Services - Official Portainer API documentation for managing Docker Swarm services, including retrieving service details.