Type Alias: Service ​
Service:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
CreatedAt? | string | - |
Endpoint? | object | - |
Endpoint.Ports? | EndpointPortConfig[] | - |
Endpoint.Spec? | EndpointSpec | - |
Endpoint.VirtualIPs? | object[] | - |
ID? | string | - |
JobStatus? | object | The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service's version, does not need to be sent with an update request. |
JobStatus.JobIteration? | ObjectVersion | JobIteration is a value increased each time a Job is executed, successfully or otherwise. "Executed", in this case, means the job as a whole has been started, not that an individual Task has been launched. A job is "Executed" when its ServiceSpec is updated. JobIteration can be used to disambiguate Tasks belonging to different executions of a job. Though JobIteration will increase with each subsequent execution, it may not necessarily increase by 1, and so JobIteration should not be used to |
JobStatus.LastExecution? | string | The last time, as observed by the server, that this job was started. |
ServiceStatus? | object | The status of the service's tasks. Provided only when requested as part of a ServiceList operation. |
ServiceStatus.CompletedTasks? | number | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. |
ServiceStatus.DesiredTasks? | number | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. |
ServiceStatus.RunningTasks? | number | The number of tasks for the service currently in the Running state. |
Spec? | ServiceSpec | - |
UpdatedAt? | string | - |
UpdateStatus? | object | The status of a service update. |
UpdateStatus.CompletedAt? | string | - |
UpdateStatus.Message? | string | - |
UpdateStatus.StartedAt? | string | - |
UpdateStatus.State? | "updating" | "paused" | "completed" | - |
Version? | ObjectVersion | - |