Zededa EdgeApplicationInstanceStatus API
The EdgeApplicationInstanceStatus API from Zededa — 35 operation(s) for edgeapplicationinstancestatus.
The EdgeApplicationInstanceStatus API from Zededa — 35 operation(s) for edgeapplicationinstancestatus.
swagger: '2.0'
info:
title: ZEDEDA App Profiles Service AppProfileService EdgeApplicationInstanceStatus API
description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
termsOfService: https://www.zededa.com/terms
version: '1.0'
contact:
name: ZEDEDA API Support
url: https://www.zededa.com/support
email: support@zededa.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: EdgeApplicationInstanceStatus
paths:
/v1/apps/instances/id/{appInstanceId}/snapshot/name/{name}:
get:
summary: Query Application instance snapshot
description: Returns the snapshot with the specified name and application instance
operationId: EdgeApplicationInstanceStatus_GetAppInstanceSnapshot
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/AppInstanceSnapshot'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: appInstanceId
description: Application Instance UUID
in: path
required: true
type: string
- name: name
description: Snapshot name. Unique across the application instance
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
delete:
summary: Delete Application instance snapshot
description: Deletes application instance snapshot with the specified name
operationId: EdgeApplicationInstanceStatus_DeleteAppInstanceSnapshot
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: appInstanceId
description: Application Instance UUID
in: path
required: true
type: string
- name: name
description: Snapshot name. Unique across the application instance
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
/v1/apps/instances/id/{id}/flowlog/classification:
get:
summary: Get edge application instance network traffic flow log
description: Get the network traffic flow log of an edge application instance as reported by the edge node where the edge application instance has been deployed.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceTrafficFlows
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ClassificationResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
in: path
required: true
type: string
- name: name
in: query
required: false
type: string
- name: startTime
in: query
required: false
type: string
format: date-time
- name: endTime
in: query
required: false
type: string
format: date-time
- name: levels
in: query
required: false
type: array
items:
type: string
enum:
- UNSPECIFIED
- DIRECTION
- ACL_ID
- ACTION
- PROTO
- REMOTE_IP
- REMOTE_PORT
- FQDN
collectionFormat: multi
- name: enterpriseId
description: deprecated field
in: query
required: false
type: string
- name: metric
in: query
required: false
type: integer
format: int64
- name: direction
in: query
required: false
type: integer
format: int64
- name: aclid
in: query
required: false
type: integer
format: int64
- name: action
in: query
required: false
type: string
enum:
- FLOW_LOG_ACTION_UNSPECIFIED
- FLOW_LOG_ACTION_DROP
- FLOW_LOG_ACTION_ACCEPT
default: FLOW_LOG_ACTION_UNSPECIFIED
- name: proto
in: query
required: false
type: integer
format: int64
- name: remoteip
in: query
required: false
type: string
- name: remoteport
in: query
required: false
type: integer
format: int64
- name: fqdn
in: query
required: false
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/id/{id}/flowlog/toptalkers:
get:
summary: Get edge application instance top talkers of the network traffic flows
description: Get the top talkers of the network traffic flows of an edge application instance as reported by the edge node where the edge application instance has been deployed.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceTopTalkers
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/TopTalkersResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
in: path
required: true
type: string
- name: name
in: query
required: false
type: string
- name: startTime
in: query
required: false
type: string
format: date-time
- name: endTime
in: query
required: false
type: string
format: date-time
- name: metricType
in: query
required: false
type: string
enum:
- FLOW_LOG_METRIC_UNSPECIFIED
- FLOW_LOG_METRIC_BYTES
- FLOW_LOG_METRIC_PACKETS
default: FLOW_LOG_METRIC_UNSPECIFIED
- name: enterpriseId
in: query
required: false
type: string
- name: Cursor.pageToken
description: Page Token
in: query
required: false
type: string
- name: Cursor.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
- name: Cursor.pageNum
description: Page Number
in: query
required: false
type: number
format: int64
- name: Cursor.pageSize
description: Defines the page size
in: query
required: false
type: number
format: int64
- name: Cursor.totalPages
description: Total number of pages to be fetched.
in: query
required: false
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/id/{id}/logs:
get:
summary: Get edge application instance log
description: Get the log of an edge application instance as reported by the edge node where the edge application instance has been deployed.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceLogs
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/AppInstanceLogsResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the app instance
in: path
required: true
type: string
- name: startTime
description: start time for querying the app instance logs
in: query
required: false
type: string
format: date-time
- name: endTime
description: entime for querying the app instacne logs
in: query
required: false
type: string
format: date-time
- name: interval
description: interval at which logs needs to fetched
in: query
required: false
type: string
format: date-time
- name: Cursor.pageToken
description: Page Token
in: query
required: false
type: string
- name: Cursor.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
- name: Cursor.pageNum
description: Page Number
in: query
required: false
type: number
format: int64
- name: Cursor.pageSize
description: Defines the page size
in: query
required: false
type: number
format: int64
- name: Cursor.totalPages
description: Total number of pages to be fetched.
in: query
required: false
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/id/{id}/opaque-status:
get:
summary: Get patch envelope opaque status as base64 encoded string
description: Get the base64 encoded opaque status of patch envelope attached to edge application instance as reported by the app instance.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceOpaqueStatusById
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/OpaqueAppInstanceStatus'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the app instance
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/id/{id}/snapshots:
get:
summary: Query Application instance snapshots
description: Returns the list of all snapshots for the specified application instance
operationId: EdgeApplicationInstanceStatus_GetAppInstanceSnapshots
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/AppInstSnapshotsList'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the app instance
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
/v1/apps/instances/id/{id}/status:
get:
summary: Get edge application instance status
description: Get the status of an edge application instance as reported by the edge node where the edge application instance has been deployed.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceStatus
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/AppInstStatusMsg'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the app instance
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/id/{objid}/events:
get:
summary: Get edge application instance events by id
description: Get configuration and status events of an edge application instance by id.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceEvents
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EventQueryResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: objid
description: Object id
in: path
required: true
type: string
- name: startTime
description: start time in timestamp
in: query
required: false
type: string
format: date-time
- name: endTime
description: end time
in: query
required: false
type: string
format: date-time
- name: severity
description: severity
in: query
required: false
type: string
- name: resource
description: resource
in: query
required: false
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
- name: next.pageNum
description: Page Number
in: query
required: false
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/id/{objid}/timeSeries/{mType}:
get:
summary: Get edge application instance resource usage timeline
description: Get the resource usage timeline of an edge application instance as reported by the edge node where the edge application instance has been deployed.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceResourceMetricsById
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/MetricQueryResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: objid
in: path
required: true
type: string
- name: mType
in: path
required: true
type: string
enum:
- UNSPECIFIED
- CPU_TOTAL
- CPU_USAGE
- MEMORY_TOTAL
- MEMORY_UTILIZATION
- NETWORK_TOTAL
- NETWORK_RATES
- EVENTS_COUNT
- STORAGE_UTILIZATION
- STORAGE_IO_ZPOOL
- STORAGE_IO_ZVOL
- name: startTime
in: query
required: false
type: string
format: date-time
- name: endTime
in: query
required: false
type: string
format: date-time
- name: interval
in: query
required: false
type: string
format: date-time
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeApplicationInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps
/v1/apps/instances/name/{name}/flowlog/classification:
get:
summary: Get edge application instance network traffic flow log
description: Get the network traffic flow log of an edge application instance as reported by the edge node where the edge application instance has been deployed.
operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceTrafficFlows2
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ClassificationResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the reques
# --- truncated at 32 KB (214 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-edgeapplicationinstancestatus-api-openapi.yml