Get edge application instance status (GET /v1/apps/instances/id/{id}/status)
GET /api/v1/apps/instances/id//status. Edge applications API reference.
Authorizations
Bearer token for user session
Headers
User-Agent specified id to track a request
Path Parameters
System defined universally unique Id of the app instance
Response
A successful response.
AppInstanceStatusMsg encapsulates the status of an app instance
app instance id
User defined name of the app instance, unique across the enterprise. Once app instance is created, name can’t be changed
3 - 256[a-zA-Z0-9][a-zA-Z0-9_.-]+User defined name of the device, unique across the enterprise. Once device is created, name can’t be changed
3 - 256[a-zA-Z0-9][a-zA-Z0-9_.-]+User defined name of the edge app, unique across the enterprise. Once edge app is created, name can’t be changed
3 - 256[a-zA-Z0-9][a-zA-Z0-9_.-]+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.
App instance status
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 Device error details
device boot time
device last update time
Io bundle status list
Software details
app instance state
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 network counter list
memory summary
storage summary
network status list
device up time
software state
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 SPU details
User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed
3 - 256[a-zA-Z0-9][a-zA-Z0-9_.-]+app instance status title
app status from third party controller
type of app
APP_TYPE_UNSPECIFIED, APP_TYPE_VM, APP_TYPE_VM_RUNTIME, APP_TYPE_CONTAINER, APP_TYPE_MODULE, APP_TYPE_DOCKER_COMPOSE System defined universally unique clusterInstance ID, unique across the enterprise.
3 - 256[a-zA-Z0-9][a-zA-Z0-9_.-]+type of deployment for the app, eg: azure, k3s, standalone
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 memory summary
list of volume ids attached
Last received counters for zvol metrics
patch envelope usage info
docker-compose container status
Runtime platform versions
App bundle specific info
Device specific info