Inspects the current deployment status for this app env

GET /resources/app.appvia.io/v2beta1/workspaces/:workspace/appenvs/:name/deploystatus

Request

Path Parameters

workspace stringrequired

Workspace to use

name stringrequired

Application environment to use

Responses

Current status of the deployment

application/json

Schema
Example (from schema)

Schema

components

undefined[]

Components describes the status of the deployed components

Array [

certReady boolean

CertReady indicates if the HTTPS certificate is ready, if exposed and TLS is enabled.

cloudResource

CloudResource identifies the status of the cloud resource associated with this component, when the component type is CloudResource.

moduleVersion string

ModuleVersion identifies which Terraform version of the module was used to build this cloud resource.

plan string

Plan identifies the cloud resource plan used for this cloud resource

ready boolean

Ready indicates whether the cloud resource represented by this component is in sync with the definition last deployed - i.e. the actual cloud resource is present and correct.

component stringrequired

Component identifies which component this status is about.

componentType stringrequired

ComponentType defines what type of component this is.

deployed boolean

Deployed will be true if this component is deployed in this environment.

endpoint string

Endpoint identifies the DNS endpoint for this component, if exposed.

exposed boolean

Exposed will be true if this component is accessible outside the cluster, i.e. has an ingress.

pods

undefined[]

Pods gives a detailed status for each pod for this component in the environment.

Array [

conditions

undefined[]

Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

Array [

lastProbeTime string

Last time we probed the condition.

lastTransitionTime string

Last time the condition transitioned from one status to another.

message string

Human-readable message indicating details about last transition.

reason string

Unique, one-word, CamelCase reason for the condition's last transition.

status stringrequired

Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

type stringrequired

Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

]

containerStatuses

undefined[]

The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

Array [

allocatedResources

object

AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.

required

properties

containerID string

ContainerID is the ID of the container in the format '://<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").

image stringrequired

Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.

imageID stringrequired

ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.

lastState

LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.

running

Details about a running container

startedAt string

Time at which the container was last (re-)started

terminated

Details about a terminated container

containerID string

Container's ID in the format '://<container_id>'

exitCode int32required

Exit status from the last termination of the container

finishedAt string

Time at which the container last terminated

message string

Message regarding the last termination of the container

reason string

(brief) reason from the last termination of the container

signal int32

Signal from the last termination of the container

startedAt string

Time at which previous execution of the container started

waiting

Details about a waiting container

message string

Message regarding why the container is not yet running.

reason string

(brief) reason the container is not yet running.

name stringrequired

Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.

ready booleanrequired

Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).

The value is typically used to determine whether a container is ready to accept traffic.

resources

Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.

claims

undefined[]

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Array [

name stringrequired

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

]

limits

object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

required

properties

requests

object

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

required

properties

restartCount int32required

RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.

started boolean

Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.

state

State holds details about the container's current condition.

running

Details about a running container

startedAt string

Time at which the container was last (re-)started

terminated

Details about a terminated container

containerID string

Container's ID in the format '://<container_id>'

exitCode int32required

Exit status from the last termination of the container

finishedAt string

Time at which the container last terminated

message string

Message regarding the last termination of the container

reason string

(brief) reason from the last termination of the container

signal int32

Signal from the last termination of the container

startedAt string

Time at which previous execution of the container started

waiting

Details about a waiting container

message string

Message regarding why the container is not yet running.

reason string

(brief) reason the container is not yet running.

]

initContainerStatuses

undefined[]

The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

Array [

allocatedResources

object

required

properties

containerID string

ContainerID is the ID of the container in the format '://<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").

image stringrequired

imageID stringrequired

ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.

lastState

running

Details about a running container

startedAt string

Time at which the container was last (re-)started

terminated

Details about a terminated container

containerID string

Container's ID in the format '://<container_id>'

exitCode int32required

Exit status from the last termination of the container

finishedAt string

Time at which the container last terminated

message string

Message regarding the last termination of the container

reason string

(brief) reason from the last termination of the container

signal int32

Signal from the last termination of the container

startedAt string

Time at which previous execution of the container started

waiting

Details about a waiting container

message string

Message regarding why the container is not yet running.

reason string

(brief) reason the container is not yet running.

name stringrequired

Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.

ready booleanrequired

The value is typically used to determine whether a container is ready to accept traffic.

resources

Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.

claims

undefined[]

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

Array [

name stringrequired

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

]

limits

object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

required

properties

requests

object

required

properties

restartCount int32required

started boolean

state

State holds details about the container's current condition.

running

Details about a running container

startedAt string

Time at which the container was last (re-)started

terminated

Details about a terminated container

containerID string

Container's ID in the format '://<container_id>'

exitCode int32required

Exit status from the last termination of the container

finishedAt string

Time at which the container last terminated

message string

Message regarding the last termination of the container

reason string

(brief) reason from the last termination of the container

signal int32

Signal from the last termination of the container

startedAt string

Time at which previous execution of the container started

waiting

Details about a waiting container

message string

Message regarding why the container is not yet running.

reason string

(brief) reason the container is not yet running.

]

message string

A human readable message indicating details about why the pod is in this condition.

phase string

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

reason string

A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'

]

podsReady int32

PodsReady shows how many pods are in a ready state for this component in the environment.

podsTotal int32

PodsTotal shows how many pods are present for this component in the environment.

tls boolean

TLS will be true if this component has TLS enabled (only relevant if exposed is true)

]

deployed boolean

Deployed will be true if one or more components are deployed to this environment

{
  "components": [
    {
      "certReady": true,
      "cloudResource": {
        "moduleVersion": "string",
        "plan": "string",
        "ready": true
      },
      "component": "string",
      "componentType": "string",
      "deployed": true,
      "endpoint": "string",
      "exposed": true,
      "pods": [
        {
          "conditions": [
            {
              "lastProbeTime": "string",
              "lastTransitionTime": "string",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "containerStatuses": [
            {
              "allocatedResources": {},
              "containerID": "string",
              "image": "string",
              "imageID": "string",
              "lastState": {
                "running": {
                  "startedAt": "string"
                },
                "terminated": {
                  "containerID": "string",
                  "exitCode": 0,
                  "finishedAt": "string",
                  "message": "string",
                  "reason": "string",
                  "signal": 0,
                  "startedAt": "string"
                },
                "waiting": {
                  "message": "string",
                  "reason": "string"
                }
              },
              "name": "string",
              "ready": true,
              "resources": {
                "claims": [
                  {
                    "name": "string"
                  }
                ],
                "limits": {},
                "requests": {}
              },
              "restartCount": 0,
              "started": true,
              "state": {
                "running": {
                  "startedAt": "string"
                },
                "terminated": {
                  "containerID": "string",
                  "exitCode": 0,
                  "finishedAt": "string",
                  "message": "string",
                  "reason": "string",
                  "signal": 0,
                  "startedAt": "string"
                },
                "waiting": {
                  "message": "string",
                  "reason": "string"
                }
              }
            }
          ],
          "initContainerStatuses": [
            {
              "allocatedResources": {},
              "containerID": "string",
              "image": "string",
              "imageID": "string",
              "lastState": {
                "running": {
                  "startedAt": "string"
                },
                "terminated": {
                  "containerID": "string",
                  "exitCode": 0,
                  "finishedAt": "string",
                  "message": "string",
                  "reason": "string",
                  "signal": 0,
                  "startedAt": "string"
                },
                "waiting": {
                  "message": "string",
                  "reason": "string"
                }
              },
              "name": "string",
              "ready": true,
              "resources": {
                "claims": [
                  {
                    "name": "string"
                  }
                ],
                "limits": {},
                "requests": {}
              },
              "restartCount": 0,
              "started": true,
              "state": {
                "running": {
                  "startedAt": "string"
                },
                "terminated": {
                  "containerID": "string",
                  "exitCode": 0,
                  "finishedAt": "string",
                  "message": "string",
                  "reason": "string",
                  "signal": 0,
                  "startedAt": "string"
                },
                "waiting": {
                  "message": "string",
                  "reason": "string"
                }
              }
            }
          ],
          "message": "string",
          "phase": "string",
          "reason": "string"
        }
      ],
      "podsReady": 0,
      "podsTotal": 0,
      "tls": true
    }
  ],
  "deployed": true
}

Validation error of supplied parameters/body

application/json

Schema
Example (from schema)

Schema

code int32required

fieldErrors

undefined[]

required

Array [

errCode stringrequired

field stringrequired

message stringrequired

]

message stringrequired

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

A generic API error containing the cause of the error

application/json

Schema
Example (from schema)

Schema

code int32required

detail stringrequired

message stringrequired

uri stringrequired

verb stringrequired

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Inspects the current deployment status for this app env

/resources/app.appvia.io/v2beta1/workspaces/:workspace/appenvs/:name/deploystatus

Request​

Path Parameters

Responses​

Request

Responses