Query status and config of edge application instances (v1)

Query status and config of edge application instances

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

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

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

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "deviceId": "<string>",
      "deviceName": "<string>",
      "appId": "<string>",
      "appName": "<string>",
      "projectId": "<string>",
      "projectName": "<string>",
      "runState": "RUN_STATE_UNSPECIFIED",
      "Storage": {
        "TotalMB": 123,
        "UsedMB": 123,
        "AllocatedMB": 123,
        "sharedStorageSummary": [
          {
            "Id": "<string>",
            "Name": "<string>",
            "AllocatedMB": 123,
            "UsedMB": 123
          }
        ],
        "Id": "<string>",
        "Name": "<string>"
      },
      "cpuUtilization": 123,
      "memoryUtilization": 123,
      "storageUtilization": 123,
      "appType": "APP_TYPE_UNSPECIFIED",
      "userDefinedVersion": "<string>",
      "swState": "SW_STATE_UNSPECIFIED",
      "swInfo": [
        {
          "version": "<string>",
          "hash": "<string>",
          "state": "SW_STATE_UNSPECIFIED",
          "disk": "<string>",
          "downloadProgress": 123,
          "imageName": "<string>"
        }
      ],
      "manifestInfo": {
        "bundleVersion": "<string>",
        "nextBundleVersion": "<string>",
        "transitionAction": "INSTANCE_TA_UNSPECIFIED",
        "params": {},
        "details": {
          "cause": "TRANS_CAUSE_UNSPECIFIED",
          "severity": "<string>",
          "scope": {
            "type": "OBJECT_TYPE_UNSPECIFIED",
            "id": "<string>"
          }
        },
        "enablevnc": true
      },
      "patchEnvelopeId": "<string>",
      "patchEnvelopeName": "<string>",
      "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
      "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"
          }
        }
      ],
      "vminfo": {
        "cpus": 123,
        "memory": 123,
        "mode": "HV_PV",
        "vnc": true,
        "vncDisplay": 123,
        "cpuPinningEnabled": true,
        "vmmMaxmem": 123,
        "bootloaderMode": "VM_BOOTLOADER_MODE_UNSPECIFIED",
        "enableOemWinLicenseKey": true,
        "disableVTPM": true
      },
      "remoteConsole": true
    }
  ],
  "summaryByState": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "totalCount": 123,
  "summaryByAppType": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByPatchEnvelope": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "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

Query Parameters

summary

boolean

app instance summary flag

appName

string

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

runState

enum<string>

default:UNSPECIFIED

aperation status

Available options:

UNSPECIFIED,

ONLINE,

HALTED,

INIT,

REBOOTING,

OFFLINE,

UNKNOWN,

UNPROVISIONED,

PROVISIONED,

SUSPECT,

DOWNLOADING,

RESTARTING,

PURGING,

HALTING,

ERROR,

VERIFYING,

LOADING,

CREATING_VOLUME,

BOOTING,

MAINTENANCE_MODE,

START_DELAYED,

BASEOS_UPDATING,

PREPARING_POWEROFF,

POWERING_OFF,

PREPARED_POWEROFF

deviceName

string

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

projectName

string

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

namePattern

string

name pattern

type

integer<int64>

type of app

Response

A successful response.

AppInstConfigStatusList is used for listing the app instance statuses

list

App instance config status · object[]

app instance status summary

Show child attributes

summaryByState

Summary is used to store the Summary details · object

app instance status by state

Show child attributes

totalCount

integer<int64>

total number of records

summaryByAppType

Summary is used to store the Summary details · object

app instance summary by application type

Show child attributes

summaryByPatchEnvelope

Summary is used to store the Summary details · object

app instance summary by patch envelope

Show child attributes

Cursor is used as filter in list operation. · object

cursor next

Show child attributes

⌘I

Query status and config of edge application instances

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

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

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

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "deviceId": "<string>",
      "deviceName": "<string>",
      "appId": "<string>",
      "appName": "<string>",
      "projectId": "<string>",
      "projectName": "<string>",
      "runState": "RUN_STATE_UNSPECIFIED",
      "Storage": {
        "TotalMB": 123,
        "UsedMB": 123,
        "AllocatedMB": 123,
        "sharedStorageSummary": [
          {
            "Id": "<string>",
            "Name": "<string>",
            "AllocatedMB": 123,
            "UsedMB": 123
          }
        ],
        "Id": "<string>",
        "Name": "<string>"
      },
      "cpuUtilization": 123,
      "memoryUtilization": 123,
      "storageUtilization": 123,
      "appType": "APP_TYPE_UNSPECIFIED",
      "userDefinedVersion": "<string>",
      "swState": "SW_STATE_UNSPECIFIED",
      "swInfo": [
        {
          "version": "<string>",
          "hash": "<string>",
          "state": "SW_STATE_UNSPECIFIED",
          "disk": "<string>",
          "downloadProgress": 123,
          "imageName": "<string>"
        }
      ],
      "manifestInfo": {
        "bundleVersion": "<string>",
        "nextBundleVersion": "<string>",
        "transitionAction": "INSTANCE_TA_UNSPECIFIED",
        "params": {},
        "details": {
          "cause": "TRANS_CAUSE_UNSPECIFIED",
          "severity": "<string>",
          "scope": {
            "type": "OBJECT_TYPE_UNSPECIFIED",
            "id": "<string>"
          }
        },
        "enablevnc": true
      },
      "patchEnvelopeId": "<string>",
      "patchEnvelopeName": "<string>",
      "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
      "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"
          }
        }
      ],
      "vminfo": {
        "cpus": 123,
        "memory": 123,
        "mode": "HV_PV",
        "vnc": true,
        "vncDisplay": 123,
        "cpuPinningEnabled": true,
        "vmmMaxmem": 123,
        "bootloaderMode": "VM_BOOTLOADER_MODE_UNSPECIFIED",
        "enableOemWinLicenseKey": true,
        "disableVTPM": true
      },
      "remoteConsole": true
    }
  ],
  "summaryByState": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "totalCount": 123,
  "summaryByAppType": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByPatchEnvelope": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "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

Query status and config of edge application instances (v1)

Authorizations

Headers

Query Parameters

Response