Get edge application instance status (GET /v1/apps/instances/name/{name}/status)

Get edge application instance status

curl --request GET \
  --url https://{apiHost}/api/v1/apps/instances/name/{name}/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/apps/instances/name/{name}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "name": "<string>",
  "deviceId": "<string>",
  "appId": "<string>",
  "tags": {},
  "adminState": "ADMIN_STATE_UNSPECIFIED",
  "errInfo": [
    {
      "description": "<string>",
      "severity": "SEVERITY_UNSPECIFIED",
      "timestamp": {},
      "entities": [
        {
          "entity": "ENTITY_UNSPECIFIED",
          "entityId": "<string>",
          "entityName": "<string>"
        }
      ],
      "retryCondition": "<string>"
    }
  ],
  "bootTime": "2023-11-07T05:31:56Z",
  "lastUpdate": "2023-11-07T05:31:56Z",
  "IoStatusList": [
    {
      "type": "IO_TYPE_UNSPECIFIED",
      "name": "<string>",
      "members": [
        "<string>"
      ],
      "appName": "<string>",
      "lteInfo": {
        "simName": "<string>",
        "cellModuleName": "<string>",
        "imsi": "<string>",
        "iccid": "<string>",
        "simcardState": "SIMCARD_STATE_INVALID",
        "imei": "<string>",
        "firmwareVersion": "<string>"
      },
      "err": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "memberList": [
        {
          "name": "<string>",
          "ioAddress": {
            "macAddress": "<string>"
          }
        }
      ]
    }
  ],
  "swInfo": [
    {
      "version": "<string>",
      "hash": "<string>",
      "state": "SW_STATE_UNSPECIFIED",
      "disk": "<string>",
      "downloadProgress": 123,
      "imageName": "<string>"
    }
  ],
  "runState": "RUN_STATE_UNSPECIFIED",
  "netCounterList": [
    {
      "ifName": "<string>",
      "txBytes": 123,
      "rxBytes": 123,
      "txPkts": 123,
      "rxPkts": 123,
      "txErrors": 123,
      "rxErrors": 123,
      "txDrops": 123,
      "rxDrops": 123,
      "txAclDrops": 123,
      "rxAclDrops": 123,
      "txAclRateLimitDrops": 123,
      "rxAclRateLimitDrops": 123
    }
  ],
  "Memory": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123
  },
  "Storage": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123,
    "sharedStorageSummary": [
      {
        "Id": "<string>",
        "Name": "<string>",
        "AllocatedMB": 123,
        "UsedMB": 123
      }
    ],
    "Id": "<string>",
    "Name": "<string>"
  },
  "netStatusList": [
    {
      "up": true,
      "macAddr": "<string>",
      "ifName": "<string>",
      "ipAddrs": [
        "<string>"
      ],
      "defaultRouters": [
        "<string>"
      ],
      "dns": {
        "servers": [
          "<string>"
        ],
        "domain": "<string>",
        "search": [
          "<string>"
        ]
      },
      "location": {
        "underlayIP": "<string>",
        "hostname": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>",
        "loc": "<string>",
        "org": "<string>",
        "postal": "<string>",
        "latlong": "<string>",
        "freeloc": "<string>"
      },
      "uplink": true,
      "proxy": {
        "networkProxy": true,
        "proxies": [
          {
            "proto": "NETWORK_PROXY_PROTO_HTTP",
            "server": "<string>",
            "port": 123
          }
        ],
        "exceptions": "<string>",
        "pacfile": "<string>",
        "networkProxyURL": "<string>",
        "wpadProxyURL": "<string>"
      },
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "gpsLocation": {
        "latitude": 123,
        "longitude": 123,
        "altitude": 123,
        "timestamp": {},
        "horizontalReliability": 123,
        "verticalReliability": 123,
        "horizontalUncertainty": 123,
        "verticalUncertainty": 123,
        "logicalLabel": "<string>"
      },
      "cellular": {
        "providers": [
          {
            "plmn": "<string>",
            "name": "<string>",
            "rat": "RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED",
            "roaming": true,
            "connectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "modem": {
          "manufacturer": "<string>",
          "model": "<string>",
          "firmwareVersion": "<string>",
          "imei": "<string>",
          "operatingState": "Z_CELLULAR_OPERATING_STATE_UNSPECIFIED",
          "controlProtocol": "Z_CELLULAR_CONTROL_PROTOCOL_UNSPECIFIED"
        },
        "simCards": [
          {
            "slotNumber": 123,
            "slotActivated": true,
            "iccid": "<string>",
            "imsi": "<string>",
            "state": "<string>"
          }
        ]
      },
      "mtu": 123,
      "pnacStatus": {
        "enabled": true,
        "supplicantState": "PNAC_SUPPLICANT_STATE_UNSPECIFIED",
        "lastAuthTimestamp": "2023-11-07T05:31:56Z",
        "err": {
          "description": "<string>",
          "severity": "SEVERITY_UNSPECIFIED",
          "timestamp": {},
          "entities": [
            {
              "entity": "ENTITY_UNSPECIFIED",
              "entityId": "<string>",
              "entityName": "<string>"
            }
          ],
          "retryCondition": "<string>"
        }
      },
      "configSource": {
        "origin": "NETWORK_CONFIG_ORIGIN_UNSPECIFIED",
        "submittedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "upTime": "2023-11-07T05:31:56Z",
  "swState": "SW_STATE_UNSPECIFIED",
  "Cpu": {
    "Utilization": 123
  },
  "projectId": "<string>",
  "title": "<string>",
  "appStatusFromTPController": {
    "appName": "<string>",
    "appId": "<string>",
    "eveDeviceId": "<string>",
    "enterpriseId": "<string>",
    "type": "CONTROLLER_TYPE_UNSPECIFIED",
    "azureStatus": {
      "azureDevStatus": {
        "oState": "<string>",
        "aState": "<string>",
        "connectionStateUpdatedTime": "<string>",
        "twin": {
          "authenticationType": "<string>",
          "cloudToDeviceMessageCount": 123,
          "reported": "aSDinaTvuI8gbWludGxpZnk=",
          "desired": "aSDinaTvuI8gbWludGxpZnk=",
          "moduleCount": 123,
          "lastDesiredStatus": "aSDinaTvuI8gbWludGxpZnk=",
          "tags": "aSDinaTvuI8gbWludGxpZnk=",
          "statusCode": 123,
          "description": "<string>"
        },
        "lastActivityTime": "<string>",
        "statusUpdateTime": "<string>"
      }
    },
    "vceStatus": {
      "vceStatusDetail": {
        "vceURL": "<string>",
        "vceEdgeId": 123,
        "activationState": "<string>",
        "edgeState": "<string>",
        "serviceState": "<string>",
        "haState": "<string>",
        "haPreviousState": "<string>",
        "bastionState": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "activationKey": "<string>",
        "activationKeyExpires": "2023-11-07T05:31:56Z",
        "activationTime": "2023-11-07T05:31:56Z",
        "serialNumber": "<string>",
        "lteRegion": "<string>",
        "alertsEnabled": true,
        "operatorAlertsEnabled": true,
        "edgeStateTime": "2023-11-07T05:31:56Z",
        "isLive": true,
        "systemUpSince": "2023-11-07T05:31:56Z",
        "serviceUpSince": "2023-11-07T05:31:56Z",
        "lastContact": "2023-11-07T05:31:56Z",
        "haLastContact": "2023-11-07T05:31:56Z",
        "haSerialNumber": "<string>",
        "modified": "2023-11-07T05:31:56Z",
        "isHub": true,
        "statusFetchedAt": "2023-11-07T05:31:56Z"
      }
    }
  },
  "appType": "APP_TYPE_UNSPECIFIED",
  "clusterId": "<string>",
  "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
  "memorySummary": {
    "AllocatedMB": 123,
    "UsedMB": 123,
    "AvailableMB": 123
  },
  "volumeRefs": [
    "<string>"
  ],
  "zpoolMetrics": {
    "readErrors": 123,
    "writeErrors": 123,
    "checksumErrors": 123,
    "bytesRead": 123,
    "bytesWrite": 123
  },
  "patchEnvelopeUsageInfo": [
    {
      "uuid": "<string>",
      "patchApiCallCount": 123,
      "version": "<string>",
      "downloadCount": "<string>"
    }
  ],
  "containerStatusList": [
    {
      "containerName": "<string>",
      "containerImage": "<string>",
      "containerEntryPoint": "<string>",
      "createTimeUTC": "<string>",
      "portMaps": [
        {
          "ip": "<string>",
          "privatePort": 123,
          "publicPort": 123,
          "type": "<string>",
          "runtimeIp": "<string>"
        }
      ],
      "containerState": "<string>",
      "uptime": 123,
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      }
    }
  ],
  "runtimePlatformVersions": {
    "agentVersion": "<string>",
    "composeVersion": "<string>",
    "containerRuntimeVersion": "<string>",
    "kernelVersion": "<string>",
    "kubernetesVersion": "<string>"
  },
  "app": {
    "appId": "<string>",
    "appName": "<string>"
  },
  "device": {
    "deviceId": "<string>",
    "deviceName": "<string>",
    "rawStatus": "<string>"
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

name

string

required

User defined name of the app instance, unique across the enterprise. Once app instance is created, name can’t be changed

Response

A successful response.

AppInstanceStatusMsg encapsulates the status of an app instance

string

app instance id

name

string

User defined name of the app instance, unique across the enterprise. Once app instance is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

deviceId

string

User defined name of the device, unique across the enterprise. Once device is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

appId

string

User defined name of the edge app, unique across the enterprise. Once edge app is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

tags

object

Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.

Show child attributes

adminState

enum<string>

default:ADMIN_STATE_UNSPECIFIED

App instance status

Available options:

ADMIN_STATE_UNSPECIFIED,

ADMIN_STATE_CREATED,

ADMIN_STATE_DELETED,

ADMIN_STATE_ACTIVE,

ADMIN_STATE_INACTIVE,

ADMIN_STATE_REGISTERED,

ADMIN_STATE_ARCHIVED,

ADMIN_STATE_DELETION_PENDING

errInfo

DeviceError is used to store the error details of the hardware. · object[]

Device error details

Show child attributes

bootTime

string<date-time>

device boot time

lastUpdate

string<date-time>

device last update time

IoStatusList

IoBundleStatus is used to store the status of the Input Output bundle · object[]

Io bundle status list

Show child attributes

swInfo

Software Information · object[]

Software details

Show child attributes

runState

enum<string>

default:RUN_STATE_UNSPECIFIED

app instance state

Available options:

RUN_STATE_UNSPECIFIED,

RUN_STATE_ONLINE,

RUN_STATE_HALTED,

RUN_STATE_INIT,

RUN_STATE_REBOOTING,

RUN_STATE_OFFLINE,

RUN_STATE_UNKNOWN,

RUN_STATE_UNPROVISIONED,

RUN_STATE_PROVISIONED,

RUN_STATE_SUSPECT,

RUN_STATE_DOWNLOADING,

RUN_STATE_RESTARTING,

RUN_STATE_PURGING,

RUN_STATE_HALTING,

RUN_STATE_ERROR,

RUN_STATE_VERIFYING,

RUN_STATE_LOADING,

RUN_STATE_CREATING_VOLUME,

RUN_STATE_BOOTING,

RUN_STATE_MAINTENANCE_MODE,

RUN_STATE_START_DELAYED,

RUN_STATE_BASEOS_UPDATING,

RUN_STATE_PREPARING_POWEROFF,

RUN_STATE_POWERING_OFF,

RUN_STATE_PREPARED_POWEROFF

netCounterList

NetworkCounter is used to store the Network Stats and Counters · object[]

network counter list

Show child attributes

Memory

Memory Summary · object

memory summary

Show child attributes

Storage

Storage Summary · object

storage summary

Show child attributes

netStatusList

NetworkStatus is used to store the Network Status · object[]

network status list

Show child attributes

upTime

string<date-time>

device up time

swState

enum<string>

default:SW_STATE_UNSPECIFIED

software state

Available options:

SW_STATE_UNSPECIFIED,

SW_STATE_INITIAL,

SW_STATE_DOWNLOAD_IN_PROGRESS,

SW_STATE_DOWNLOADED,

SW_STATE_VERIFIED,

SW_STATE_INSTALLED,

SW_STATE_BOOTING,

SW_STATE_RUNNING,

SW_STATE_HALTING,

SW_STATE_HALTED,

SW_STATE_REFRESHING,

SW_STATE_PURGING,

SW_STATE_RESOLVING_TAG,

SW_STATE_RESOLVED_TAG,

SW_STATE_CREATING_VOLUME,

SW_STATE_CREATED_VOLUME,

SW_STATE_VERIFYING,

SW_STATE_LOADING,

SW_STATE_LOADED,

SW_STATE_AWAITNETWORKINSTANCE

Cpu

CPU Summary · object

SPU details

Show child attributes

projectId

string

User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

title

string

app instance status title

appStatusFromTPController

object

app status from third party controller

Show child attributes

appType

enum<string>

default:APP_TYPE_UNSPECIFIED

type of app

Available options:

APP_TYPE_UNSPECIFIED,

APP_TYPE_VM,

APP_TYPE_VM_RUNTIME,

APP_TYPE_CONTAINER,

APP_TYPE_MODULE,

APP_TYPE_DOCKER_COMPOSE

clusterId

string

System defined universally unique clusterInstance ID, unique across the enterprise.

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

deploymentType

enum<string>

default:DEPLOYMENT_TYPE_UNSPECIFIED

type of deployment for the app, eg: azure, k3s, standalone

Available options:

DEPLOYMENT_TYPE_UNSPECIFIED,

DEPLOYMENT_TYPE_STAND_ALONE,

DEPLOYMENT_TYPE_AZURE,

DEPLOYMENT_TYPE_K3S,

DEPLOYMENT_TYPE_AWS,

DEPLOYMENT_TYPE_K3S_AZURE,

DEPLOYMENT_TYPE_K3S_AWS,

DEPLOYMENT_TYPE_VMWARE_VCE,

DEPLOYMENT_TYPE_VMWARE_TKG_ATTACH,

DEPLOYMENT_TYPE_DOCKER_RUNTIME

memorySummary

App Instance Memory Summary · object

memory summary

Show child attributes

volumeRefs

string[]

list of volume ids attached

zpoolMetrics

object

Last received counters for zvol metrics

Show child attributes

patchEnvelopeUsageInfo

object[]

patch envelope usage info

Show child attributes

containerStatusList

object[]

docker-compose container status

Show child attributes

runtimePlatformVersions

object

Runtime platform versions

Show child attributes

app

object

App bundle specific info

Show child attributes

device

object

Device specific info

Show child attributes

⌘I

Get edge application instance status

curl --request GET \
  --url https://{apiHost}/api/v1/apps/instances/name/{name}/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/apps/instances/name/{name}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "name": "<string>",
  "deviceId": "<string>",
  "appId": "<string>",
  "tags": {},
  "adminState": "ADMIN_STATE_UNSPECIFIED",
  "errInfo": [
    {
      "description": "<string>",
      "severity": "SEVERITY_UNSPECIFIED",
      "timestamp": {},
      "entities": [
        {
          "entity": "ENTITY_UNSPECIFIED",
          "entityId": "<string>",
          "entityName": "<string>"
        }
      ],
      "retryCondition": "<string>"
    }
  ],
  "bootTime": "2023-11-07T05:31:56Z",
  "lastUpdate": "2023-11-07T05:31:56Z",
  "IoStatusList": [
    {
      "type": "IO_TYPE_UNSPECIFIED",
      "name": "<string>",
      "members": [
        "<string>"
      ],
      "appName": "<string>",
      "lteInfo": {
        "simName": "<string>",
        "cellModuleName": "<string>",
        "imsi": "<string>",
        "iccid": "<string>",
        "simcardState": "SIMCARD_STATE_INVALID",
        "imei": "<string>",
        "firmwareVersion": "<string>"
      },
      "err": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "memberList": [
        {
          "name": "<string>",
          "ioAddress": {
            "macAddress": "<string>"
          }
        }
      ]
    }
  ],
  "swInfo": [
    {
      "version": "<string>",
      "hash": "<string>",
      "state": "SW_STATE_UNSPECIFIED",
      "disk": "<string>",
      "downloadProgress": 123,
      "imageName": "<string>"
    }
  ],
  "runState": "RUN_STATE_UNSPECIFIED",
  "netCounterList": [
    {
      "ifName": "<string>",
      "txBytes": 123,
      "rxBytes": 123,
      "txPkts": 123,
      "rxPkts": 123,
      "txErrors": 123,
      "rxErrors": 123,
      "txDrops": 123,
      "rxDrops": 123,
      "txAclDrops": 123,
      "rxAclDrops": 123,
      "txAclRateLimitDrops": 123,
      "rxAclRateLimitDrops": 123
    }
  ],
  "Memory": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123
  },
  "Storage": {
    "TotalMB": 123,
    "UsedMB": 123,
    "AllocatedMB": 123,
    "sharedStorageSummary": [
      {
        "Id": "<string>",
        "Name": "<string>",
        "AllocatedMB": 123,
        "UsedMB": 123
      }
    ],
    "Id": "<string>",
    "Name": "<string>"
  },
  "netStatusList": [
    {
      "up": true,
      "macAddr": "<string>",
      "ifName": "<string>",
      "ipAddrs": [
        "<string>"
      ],
      "defaultRouters": [
        "<string>"
      ],
      "dns": {
        "servers": [
          "<string>"
        ],
        "domain": "<string>",
        "search": [
          "<string>"
        ]
      },
      "location": {
        "underlayIP": "<string>",
        "hostname": "<string>",
        "city": "<string>",
        "region": "<string>",
        "country": "<string>",
        "loc": "<string>",
        "org": "<string>",
        "postal": "<string>",
        "latlong": "<string>",
        "freeloc": "<string>"
      },
      "uplink": true,
      "proxy": {
        "networkProxy": true,
        "proxies": [
          {
            "proto": "NETWORK_PROXY_PROTO_HTTP",
            "server": "<string>",
            "port": 123
          }
        ],
        "exceptions": "<string>",
        "pacfile": "<string>",
        "networkProxyURL": "<string>",
        "wpadProxyURL": "<string>"
      },
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      },
      "gpsLocation": {
        "latitude": 123,
        "longitude": 123,
        "altitude": 123,
        "timestamp": {},
        "horizontalReliability": 123,
        "verticalReliability": 123,
        "horizontalUncertainty": 123,
        "verticalUncertainty": 123,
        "logicalLabel": "<string>"
      },
      "cellular": {
        "providers": [
          {
            "plmn": "<string>",
            "name": "<string>",
            "rat": "RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED",
            "roaming": true,
            "connectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "modem": {
          "manufacturer": "<string>",
          "model": "<string>",
          "firmwareVersion": "<string>",
          "imei": "<string>",
          "operatingState": "Z_CELLULAR_OPERATING_STATE_UNSPECIFIED",
          "controlProtocol": "Z_CELLULAR_CONTROL_PROTOCOL_UNSPECIFIED"
        },
        "simCards": [
          {
            "slotNumber": 123,
            "slotActivated": true,
            "iccid": "<string>",
            "imsi": "<string>",
            "state": "<string>"
          }
        ]
      },
      "mtu": 123,
      "pnacStatus": {
        "enabled": true,
        "supplicantState": "PNAC_SUPPLICANT_STATE_UNSPECIFIED",
        "lastAuthTimestamp": "2023-11-07T05:31:56Z",
        "err": {
          "description": "<string>",
          "severity": "SEVERITY_UNSPECIFIED",
          "timestamp": {},
          "entities": [
            {
              "entity": "ENTITY_UNSPECIFIED",
              "entityId": "<string>",
              "entityName": "<string>"
            }
          ],
          "retryCondition": "<string>"
        }
      },
      "configSource": {
        "origin": "NETWORK_CONFIG_ORIGIN_UNSPECIFIED",
        "submittedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "upTime": "2023-11-07T05:31:56Z",
  "swState": "SW_STATE_UNSPECIFIED",
  "Cpu": {
    "Utilization": 123
  },
  "projectId": "<string>",
  "title": "<string>",
  "appStatusFromTPController": {
    "appName": "<string>",
    "appId": "<string>",
    "eveDeviceId": "<string>",
    "enterpriseId": "<string>",
    "type": "CONTROLLER_TYPE_UNSPECIFIED",
    "azureStatus": {
      "azureDevStatus": {
        "oState": "<string>",
        "aState": "<string>",
        "connectionStateUpdatedTime": "<string>",
        "twin": {
          "authenticationType": "<string>",
          "cloudToDeviceMessageCount": 123,
          "reported": "aSDinaTvuI8gbWludGxpZnk=",
          "desired": "aSDinaTvuI8gbWludGxpZnk=",
          "moduleCount": 123,
          "lastDesiredStatus": "aSDinaTvuI8gbWludGxpZnk=",
          "tags": "aSDinaTvuI8gbWludGxpZnk=",
          "statusCode": 123,
          "description": "<string>"
        },
        "lastActivityTime": "<string>",
        "statusUpdateTime": "<string>"
      }
    },
    "vceStatus": {
      "vceStatusDetail": {
        "vceURL": "<string>",
        "vceEdgeId": 123,
        "activationState": "<string>",
        "edgeState": "<string>",
        "serviceState": "<string>",
        "haState": "<string>",
        "haPreviousState": "<string>",
        "bastionState": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "activationKey": "<string>",
        "activationKeyExpires": "2023-11-07T05:31:56Z",
        "activationTime": "2023-11-07T05:31:56Z",
        "serialNumber": "<string>",
        "lteRegion": "<string>",
        "alertsEnabled": true,
        "operatorAlertsEnabled": true,
        "edgeStateTime": "2023-11-07T05:31:56Z",
        "isLive": true,
        "systemUpSince": "2023-11-07T05:31:56Z",
        "serviceUpSince": "2023-11-07T05:31:56Z",
        "lastContact": "2023-11-07T05:31:56Z",
        "haLastContact": "2023-11-07T05:31:56Z",
        "haSerialNumber": "<string>",
        "modified": "2023-11-07T05:31:56Z",
        "isHub": true,
        "statusFetchedAt": "2023-11-07T05:31:56Z"
      }
    }
  },
  "appType": "APP_TYPE_UNSPECIFIED",
  "clusterId": "<string>",
  "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
  "memorySummary": {
    "AllocatedMB": 123,
    "UsedMB": 123,
    "AvailableMB": 123
  },
  "volumeRefs": [
    "<string>"
  ],
  "zpoolMetrics": {
    "readErrors": 123,
    "writeErrors": 123,
    "checksumErrors": 123,
    "bytesRead": 123,
    "bytesWrite": 123
  },
  "patchEnvelopeUsageInfo": [
    {
      "uuid": "<string>",
      "patchApiCallCount": 123,
      "version": "<string>",
      "downloadCount": "<string>"
    }
  ],
  "containerStatusList": [
    {
      "containerName": "<string>",
      "containerImage": "<string>",
      "containerEntryPoint": "<string>",
      "createTimeUTC": "<string>",
      "portMaps": [
        {
          "ip": "<string>",
          "privatePort": 123,
          "publicPort": 123,
          "type": "<string>",
          "runtimeIp": "<string>"
        }
      ],
      "containerState": "<string>",
      "uptime": 123,
      "errInfo": {
        "description": "<string>",
        "severity": "SEVERITY_UNSPECIFIED",
        "timestamp": {},
        "entities": [
          {
            "entity": "ENTITY_UNSPECIFIED",
            "entityId": "<string>",
            "entityName": "<string>"
          }
        ],
        "retryCondition": "<string>"
      }
    }
  ],
  "runtimePlatformVersions": {
    "agentVersion": "<string>",
    "composeVersion": "<string>",
    "containerRuntimeVersion": "<string>",
    "kernelVersion": "<string>",
    "kubernetesVersion": "<string>"
  },
  "app": {
    "appId": "<string>",
    "appName": "<string>"
  },
  "device": {
    "deviceId": "<string>",
    "deviceName": "<string>",
    "rawStatus": "<string>"
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Get edge application instance status (GET /v1/apps/instances/name/{name}/status)

Authorizations

Headers

Path Parameters

Response