Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zededa VolumeInstanceStatus API

The VolumeInstanceStatus API from Zededa — 6 operation(s) for volumeinstancestatus.

Zededa VolumeInstanceStatus API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include VolumeInstanceStatus. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 33 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://zedcontrol.zededa.net/api.

6 operations 6 paths 33 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://zedcontrol.zededa.net/api
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zededa VolumeInstanceStatus API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (BearerToken). By default, every request must be authenticated.

  • BearerToken — Bearer token for user session

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

VolumeInstanceStatus 6
GET
/v1/volumes/instances/id/{id}/status
Get edge volume instance status
VolumeInstanceStatus_GetVolumeInstanceStatus 2 params → 200401403404500504default
GET
/v1/volumes/instances/id/{objid}/events
Get edge volume instance events by id
VolumeInstanceStatus_GetVolumeInstanceEvents 11 params → 200401403404500504default
GET
/v1/volumes/instances/name/{name}/status
Get edge volume instance status
VolumeInstanceStatus_GetVolumeInstanceStatusByName 2 params → 200401403404500504default
GET
/v1/volumes/instances/name/{objname}/events
Get edge volume instance events by name
VolumeInstanceStatus_GetVolumeInstanceEventsByName 11 params → 200401403404500504default
GET
/v1/volumes/instances/status
Query status of edge volume instances
VolumeInstanceStatus_QueryVolumeInstanceStatus 17 params → 200400401403500504default
GET
/v1/volumes/instances/status-config
Query status and config of edge volume instances
VolumeInstanceStatus_QueryVolumeInstanceStatusConfig 17 params → 200400401403500504default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), VolInstStatusMsg (15 properties), EventQueryResponseItem (14 properties), VolInstStatusSummaryMsg (13 properties). Each schema is shown below with its type and property counts.

BlobInfo
object
6 properties
ZcOpsType
string
VolInstResource
object
2 properties
Severity
string
ObjectType
string
Summary
object
Summary is used to store the Summary details
3 properties
EventQueryResponseItem
object
Event query response item payload
14 properties
infoStorageVolumeState
string
Entity
string
- ENTITYUNSPECIFIED: Invalid Device Entity - ENTITYBASEOS: Base OS entity - ENTITYSYSTEMADAPTER: System Adapter Entity - ENTITYVAULT: Vault Entity - ENTITYATTE…
VolumeInstanceReplicaStatus
object
3 properties
DeviceError
object
DeviceError store the error occurred at the device side
5 properties 4 required
infoStorageVolumePVCStatus
string
protobufAny
object
2 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
VolumeInstanceType
string
EventQueryResponse
object
Event query response request payload
3 properties 2 required
DeviceEntity
object
3 properties
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
DeviceObjectUsageInfo
object
DeviceObjectUsageInfo provides the metadata of object usage on the device
3 properties 3 required
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
VolInstStatusMsg
object
15 properties
VolInstStatusListMsg
object
5 properties
ClusterVolInstanceStatus
object
8 properties
infoStorageHealthStatus
string
StorageHealthStatus is a higher level tracking status to show redundancy/failure-zone level and rebuild progress.
EventSource
string
- EVENTSOURCEUNSPECIFIED: Default - EVENTSOURCESYSTEM: Event is generated as a result of status change reported by edge node / application - EVENTSOURCEUSER: E…
ZsrvResponse
object
15 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
infoStorageVolumeReplicaStatus
string
StorageVolumeReplicaStatus is a higher level status which combines replica and engine status to show a simplified view of a replica rebuild state.
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
SWState
string
- SWSTATERESOLVINGTAG: Prior to DOWNLOADSTARTED we go through these: Resolving an image tag - SWSTATERESOLVEDTAG: Tag has been resolved/failed - SWSTATECREATIN…
VolInstStatusSummaryMsg
object
13 properties
infoStorageVolumeRobustness
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-volumeinstancestatus-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService API
Zededa ArtifactManager API
Zededa AssetGroupService API
Zededa BulkJobOps API
Zededa CertificateEnrollmentProfileConfiguration API
Zededa CloudDiagnostics API
Zededa ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API