NSX-T Data Center REST API

ContainerApplication (type)

{
  "description": "Container application within a project.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerApplication", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "cluster_ips": {
      "description": "The IPv4 and IPv6 clusterIPs of the container application.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of cluster IPs", 
      "type": "array"
    }, 
    "container_cluster_id": {
      "description": "Identifier of the container cluster this container application belongs to.", 
      "readonly": true, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "container_project_id": {
      "description": "Identifier of the project which this container application belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the project", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Identifier of the container application on container cluster e.g. PCF app id, k8s service id.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container application", 
      "type": "string"
    }, 
    "load_balancer_ingress": {
      "description": "Specifies list of load-balancer ingress points", 
      "items": {
        "$ref": "ContainerLoadBalancerIngress
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of load-balancer ingress points", 
      "type": "array"
    }, 
    "network_errors": {
      "description": "List of network errors related to container application.", 
      "items": {
        "$ref": "NetworkError
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Network errors", 
      "type": "array"
    }, 
    "network_status": {
      "description": "Network status of container application.", 
      "enum": [
        "HEALTHY", 
        "UNHEALTHY"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Network status of container application", 
      "type": "string"
    }, 
    "node_port_local_endpoints": {
      "description": "Specifies list of local endpoint, when service is NodePortLocal.", 
      "items": {
        "$ref": "NodePortLocalEndpoint
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of NodePortLocalEndpoint", 
      "type": "array"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container application in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "service_ports": {
      "description": "Specifies list of service port.", 
      "items": {
        "$ref": "ContainerServicePort
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of service port", 
      "type": "array"
    }, 
    "status": {
      "description": "Status of the container application.", 
      "enum": [
        "UNKNOWN", 
        "HEALTHY", 
        "UP", 
        "DOWN", 
        "DEGRADED"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Status of the container application", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "type": {
      "descrption": "Specifies the type of container application. e.g. In case of Kubernetes\ncontainer cluster, it specifies type of service like ClusterIP, NodePort,\nLoadBalancer or ExternalName.\n", 
      "enum": [
        "CLUSTER_IP", 
        "NODE_PORT", 
        "LOAD_BALANCER", 
        "EXTERNAL_NAME"
      ], 
      "readonly": false, 
      "required": false, 
      "title": "Type of container application", 
      "type": "string"
    }
  }, 
  "title": "Container application within a project", 
  "type": "object"
}