--- title: "Get status of service_name.instance_name" method: GET path: "/services/{service}/{instance}/status" tags: ["service"] --- # Get status of service_name.instance_name `GET /services/{service}/{instance}/status` ## Path parameters - `service` string, required - `instance` string, required ## Query parameters - `verbose` integer - `include_smartstack` boolean - `include_envoy` boolean - `include_mesos` boolean - `new` boolean - `all_namespaces` boolean ## Response `200` Detailed status of an instance - InstanceStatus - `service` string — Service name - `instance` string — Instance name - `git_sha` string — Git sha of a service - `kubernetes` InstanceStatusKubernetes - `desired_state` 'start' | 'stop', required — Desired state of a service, for Kubernetes - `app_count` integer, required — The number of different running versions of the same service (0 for stopped, 1 for running and 1+ for bouncing) - `app_id` string — ID of the desired version of a service instance - `bounce_method` 'brutal' | 'upthendown' | 'downthenup' | 'crossover', required — Method to transit between new and old versions of a service - `deploy_status` 'Running' | 'Deploying' | 'Stopped' | 'Delayed' | 'Waiting' | 'NotRunning' — Deploy status of a Kubernetes service - `deploy_status_message` string — Reason for the deploy status - `backoff_seconds` integer — backoff in seconds before launching the next task - `running_instance_count` integer — The number of actual running instances of the service - `expected_instance_count` integer — The number of desired instances of the service - `create_timestamp` number, float — Unix timestamp when this app was created - `smartstack` SmartstackStatus - `registration` string — Registration name of the service in Smartstack - `expected_backends_per_location` integer — Number of backends expected to be present in each location - `locations` SmartstackLocation[] — Locations the service is deployed - `name` string — Name of the location - `running_backends_count` integer — Number of running backends for the service in this location - `backends` SmartstackBackend[] — Smartstack backends running in this location - `hostname` string — Name of the host on which the backend is running - `port` integer — Port number on which the backend responds - `status` string — Status of the backend in HAProxy - `check_status` string — Status of last health check of the backend - `check_code` string — Check code reported by HAProxy - `check_duration` integer — Duration in ms of the last health check performed by HAProxy - `last_change` integer — Seconds since last change in backend status - `has_associated_task` boolean — Whether this backend has an associated task running - `envoy` EnvoyStatus - `registration` string — Registration name of the service in Smartstack - `expected_backends_per_location` integer — Number of backends expected to be present in each location - `locations` EnvoyLocation[] — Locations the service is deployed - `name` string — Name of the location - `running_backends_count` integer — Number of running backends for the service in this location - `backends` EnvoyBackend[] — Envoy backends running in this location - `address` string — Address of the host on which the backend is running - `port_value` integer — Port number on which the backend responds - `hostname` string — Name of the host on which the backend is running - `eds_health_status` string — Status of the backend in Envoy as reported by the EDS - `weight` integer — The weight of this backend in the cluster - `has_associated_task` boolean — Whether this backend has an associated task running - `is_proxied_through_casper` boolean — Whether this backend is proxied through Casper - `namespace` string — The namespace this app is running - `replicasets` KubernetesReplicaSet[] — ReplicaSets associated to this app - `name` string — name of the replicaset in Kubernetes - `ready_replicas` integer — number of ready replicas for the replicaset - `replicas` integer — number of desired replicas for the replicaset - `create_timestamp` number, float — Time at which the replicaset was created - `git_sha` string, nullable — Service git SHA that this replicaset runs - `config_sha` string, nullable — Hash of the configuration of this replicaset - `pods` KubernetesPod[] — Pods associated to this app - `name` string — name of the pod in Kubernetes - `host` string — name of the pod's host - `deployed_timestamp` number, float — Time at which the pod was deployed - `phase` string — The status of the pod - `ready` boolean — Whether or not the pod is ready (i.e. all containers up) - `containers` KubernetesContainer[] - `name` string — Name of the container - `tail_lines` TaskTailLines - `stdout` string[] — The requested number of lines from the task's stdout - `stderr` string[] — The requested number of lines from the task's stderr - `error_message` string — Error message when fetching tail lines fails - `reason` string, nullable — short message explaining the pod's state - `message` string, nullable — long message explaining the pod's state - `delete_timestamp` number, float, nullable — Unix timestamp at which pod deletion was requested (indicates terminating state) - `autoscaling_status` object — HPA associated to this app - `min_instances` integer — min_instances as specified in yelpsoa_configs - `max_instances` integer — min_instances as specified in yelpsoa_configs - `desired_replicas` integer — desired number of _instances as calculated by HPA - `last_scale_time` string — timestamp of last autoscale - `metrics` HPAMetric[] — Current metrics - `name` string — name of the metric - `target_value` string — setpoint/target_value as specified in yelpsoa_configs - `current_value` string — setpoint/target_value as specified in yelpsoa_configs - `error_message` string — Error message when a kubernetes object (Deployment/Statefulset) cannot be found - `active_shas` array[] — List of git/config SHAs running. - string[] - `active_versions` array[] — List of git SHA/image_version/config SHAs running. - string[] - `kubernetes_v2` InstanceStatusKubernetesV2 - `app_name` string — Name of Kubernetes Deployment or Statefulset for instance - `desired_state` string — Desired state of the app (start or stop) - `desired_instances` integer — Number of instances desired for this app - `error_message` string — Error message if we cannot assemble status for the instance - `versions` KubernetesVersion[] — Individual versions of the instance - `container_port` integer — Port the container is expecting to receive traffic on - `type` string — Type of version (ReplicaSet or ControllerRevision) - `create_timestamp` number, float — Unix timestamp when version was created - `git_sha` string — Git SHA of service code for this version of the instance - `config_sha` string — SHA of configuration for this instance - `name` string — Name of the version (only valid for ReplicaSets) - `pods` KubernetesPodV2[] — Pods associated to this version - `create_timestamp` number, float — Unix timestamp at which pod was created - `delete_timestamp` number, float, nullable — Unix timestamp at which pod should be deleted - `ip` string, nullable — Pod IP - `host` string, nullable — Host IP this pod was scheduled on - `name` string — Pod name - `phase` string — The lifecycle phase of the pod - `ready` boolean — Whether or not the pod is ready - `scheduled` boolean — Whether or not the pod is scheduled - `reason` string, nullable — brief description of the pod's state - `message` string, nullable — short message with details about the pod's state - `containers` KubernetesContainerV2[] - `name` string — Name of the container - `state` string — State of the container - `last_state` string, nullable — State of the container - `restart_count` integer, nullable — Number of restarts since container creation - `reason` string, nullable — Short description of the state of the container - `message` string, nullable — Details about the state of the container - `last_reason` string, nullable — Short description of the previous state of the container - `last_message` string, nullable — Details about the previous state of the container - `last_duration` number, float, nullable — Duration in seconds of previous state - `max_healthcheck_period` number, float, nullable — Time in seconds for maximum healthcheck failure - `timestamp` number, float, nullable — Unix timestamp at which state transitioned - `replicas` integer — Desired number of replicas for this version - `ready_replicas` integer — Number of replicas currently ready - `namespace` string — Kubernetes namespace this version is in - `tron` InstanceStatusTron - `job_name` string, required — The name of this job - `job_status` string — The status of the job - `job_schedule` string — The job schedule of the job - `job_url` string, required — The dashboard url of the job - `action_name` string — The name of the action - `action_state` string — The state of the action - `action_raw_command` string — The raw command of the action - `action_command` string — The command of the action - `action_start_time` string — The start time of the action - `action_stderr` string — The stderr command of the action - `action_stdout` string — The stdout command of the action - `adhoc` AdhocLaunchHistory[] — List of runs associated with job - `launch_time` string — when the job was launched - `run_id` string — id of the single run - `framework_id` string — framework id - `flink` object — Nullable Flink instance status and metadata - `status` InstanceStatusFlinkStatus — Flink instance status - `metadata` InstanceStatusFlinkMetadata — Flink instance metadata - `flinkeks` object — Nullable Flink instance status and metadata - `status` InstanceStatusFlinkStatus — Flink instance status - `metadata` InstanceStatusFlinkMetadata — Flink instance metadata - `kafkacluster` object — Nullable KafkaCluster instance status and metadata - `status` InstanceStatusKafkaCluster — Kafka instance status - `metadata` InstanceMetadataKafkaCluster — Kafka instance metadata - `cassandracluster` object — Nullable CassandraCluster instance status - `status` InstanceStatusCassandraCluster — Cassandra instance status - `cassandraclustereks` object — Nullable CassandraCluster instance status - `status` InstanceStatusCassandraCluster — Cassandra instance status ## Other responses - `404` — Deployment key not found - `500` — Instance failure --- [API](https://skmtc.net/yelp/apis/paasta-api.md) · [All operations](https://skmtc.net/yelp/apis/paasta-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yelp/paasta-api/versions/0f10edc28b60/schema)