Inspect a service

/v1.33

GET

/services/{id}

Service

Response Example

200 - Example 1

{
    "CreatedAt": "2016-06-07T21:05:51.880065305Z",
    "Endpoint": {
        "Ports": [
            {
                "Protocol": "tcp",
                "PublishedPort": 30001,
                "TargetPort": 6379
            }
        ],
        "Spec": {
            "Mode": "vip",
            "Ports": [
                {
                    "Protocol": "tcp",
                    "PublishedPort": 30001,
                    "TargetPort": 6379
                }
            ]
        },
        "VirtualIPs": [
            {
                "Addr": "10.255.0.2/16",
                "NetworkID": "4qvuz4ko70xaltuqbt8956gd1"
            },
            {
                "Addr": "10.255.0.3/16",
                "NetworkID": "4qvuz4ko70xaltuqbt8956gd1"
            }
        ]
    },
    "ID": "9mnpnzenvg8p8tdbtq4wvbkcz",
    "Spec": {
        "EndpointSpec": {
            "Mode": "vip",
            "Ports": [
                {
                    "Protocol": "tcp",
                    "PublishedPort": 30001,
                    "TargetPort": 6379
                }
            ]
        },
        "Mode": {
            "Replicated": {
                "Replicas": 1
            }
        },
        "Name": "hopeful_cori",
        "RollbackConfig": {
            "Delay": 1000000000,
            "FailureAction": "pause",
            "MaxFailureRatio": 0.15,
            "Monitor": 15000000000,
            "Parallelism": 1
        },
        "TaskTemplate": {
            "ContainerSpec": {
                "Image": "redis"
            },
            "ForceUpdate": 0,
            "Placement": {},
            "Resources": {
                "Limits": {},
                "Reservations": {}
            },
            "RestartPolicy": {
                "Condition": "any",
                "MaxAttempts": 0
            }
        },
        "UpdateConfig": {
            "Delay": 1000000000,
            "FailureAction": "pause",
            "MaxFailureRatio": 0.15,
            "Monitor": 15000000000,
            "Parallelism": 1
        }
    },
    "UpdatedAt": "2016-06-07T21:07:29.962229872Z",
    "Version": {
        "Index": 19
    }
}

Request

Path Params

string

required

ID or name of service.

Query Params

insertDefaults

string

optional

Fill empty fields with default values.

Responses

🟢200no error

application/json

Body

CreatedAt

string <dateTime>

optional

Endpoint

object

optional

Ports

array[object (EndpointPortConfig) {4}]

optional

Spec

object (EndpointSpec)

optional

Properties that can be configured to access and load balance a service.

VirtualIPs

array [object {2}]

optional

string

optional

Spec

object (ServiceSpec)

optional

User modifiable configuration for a service.

EndpointSpec

object (EndpointSpec)

optional

Properties that can be configured to access and load balance a service.

Labels

object

optional

User-defined key/value metadata.

Mode

object

optional

Scheduling mode for the service.

Name

string

optional

Name of the service.

Networks

array [object {2}]

optional

Array of network names or IDs to attach the service to.

RollbackConfig

object

optional

Specification for the rollback strategy of the service.

TaskTemplate

object (TaskSpec)

optional

User modifiable task configuration.

UpdateConfig

object

optional

Specification for the update strategy of the service.

UpdateStatus

object

optional

The status of a service update.

CompletedAt

string <dateTime>

optional

Message

string

optional

StartedAt

string <dateTime>

optional

State

enum<string>

optional

Allowed values:

updatingpausedcompleted

UpdatedAt

string <dateTime>

optional

Version

object (ObjectVersion)

optional

The version number of the object such as node, service, etc. This is needed to avoid conflicting writes.
The client must send the version number along with the modified specification when updating these objects.
This approach ensures safe concurrency and determinism in that the change on the object
may not be applied if the version number has changed from the last read. In other words,
if two update requests specify the same base version, only one of the requests can succeed.
As a result, two separate update requests that happen at the same time will not
unintentionally overwrite each other.

Index

integer <uint64>

optional

Example:

373531

🟠404no such service

🔴500server error

🔴503node is not part of a swarm

Modified at 2022-09-10 17:56:07

Delete a service

Get service logs