Returns the specified application deployment

GET 
/v1/appDeployments/:uid

Returns the specified application deployment

Request

Path Parameters

uid stringrequired

Application deployment uid

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

Application deployment spec

config

object

Application deployment config response

target

object

Application deployment target config response

clusterRef

object

Application deployment cluster reference

deploymentClusterTypestring

Possible values: [virtual, host]

Application deployment source cluster type[ "virtualCluster", "hostCluster" ]

namestring

Application deployment cluster name

uidstring

Application deployment cluster uid

envRef

object

Application deployment target environment reference

namestring

Application deployment target resource name

typestring

Application deployment target resource type [ "nestedCluster", "clusterGroup" ]

uidstring

Application deployment target resource uid

profile

object

Application deployment profile

metadata

object

Application deployment profile metadata

namestring

Application deployment profile name

uidstring

Application deployment profile uid

versionstring

Application deployment profile version

template

object

Application profile template information

appTiers

object[]

Application profile tiers

Array [

namestring

Application tier name

typestring

Possible values: [manifest, helm, operator-instance, container]

Default value: manifest

uidstring

Application tier uid to uniquely identify the tier

versionstring

Application tier version

]

registryRefs

object[]

Application profile registries reference

Array [

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

]

status

object

Application deployment status

appTiers

object[]

Application deployment tiers

Array [

condition

object

lastProbeTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

lastTransitionTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

messagestring

Human-readable message indicating details about last transition.

reasonstring

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

statusstringrequired

typestringrequired

endTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

manifests

object[]

Array [

condition

object

lastProbeTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

lastTransitionTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

messagestring

Human-readable message indicating details about last transition.

reasonstring

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

statusstringrequired

typestringrequired

namestring

uidstring

]

namestring

profileUidstring

services

object[]

Array [

hoststring

IP or Host from svc.Status.LoadBalancerStatus.Ingress

namestring

name of the loadbalancer service

ports

object[]

port this service exposed

Array [

portint32required

The port that will be exposed by this service.

protocolstring

]

]

startTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

typestring

versionstring

]

lifecycleStatus

msgstring

error or success msg of lifecycle

statusstring

Possible values: [Pausing, Paused, Resuming, Running, Error]

lifecycle status

statestring

Application deployment state [ "Pending", "Deploying", "Deployed", "Updating" ]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-26T20:10:08.194Z",
    "deletionTimestamp": "2024-07-26T20:10:08.194Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-26T20:10:08.194Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "config": {
      "target": {
        "clusterRef": {
          "deploymentClusterType": "virtual",
          "name": "string",
          "uid": "string"
        },
        "envRef": {
          "name": "string",
          "type": "string",
          "uid": "string"
        }
      }
    },
    "profile": {
      "metadata": {
        "name": "string",
        "uid": "string",
        "version": "string"
      },
      "template": {
        "appTiers": [
          {
            "name": "string",
            "type": "manifest",
            "uid": "string",
            "version": "string"
          }
        ],
        "registryRefs": [
          {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ]
      }
    }
  },
  "status": {
    "appTiers": [
      {
        "condition": {
          "lastProbeTime": "2024-07-26T20:10:08.195Z",
          "lastTransitionTime": "2024-07-26T20:10:08.195Z",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        },
        "endTime": "2024-07-26T20:10:08.195Z",
        "manifests": [
          {
            "condition": {
              "lastProbeTime": "2024-07-26T20:10:08.195Z",
              "lastTransitionTime": "2024-07-26T20:10:08.195Z",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "profileUid": "string",
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": 0,
                "protocol": "string"
              }
            ]
          }
        ],
        "startTime": "2024-07-26T20:10:08.195Z",
        "type": "string",
        "version": "string"
      }
    ],
    "lifecycleStatus": {
      "msg": "string",
      "status": "Pausing"
    },
    "state": "string"
  }
}

Loading...