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 ClusterStatus API

The ClusterStatus API from Zededa — 3 operation(s) for clusterstatus.

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

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

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

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

3 operations 3 paths 40 schemas 3 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 ClusterStatus 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 3

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

ClusterStatus 3
GET
/v1/cluster/id/{id}/raw/status
Get Edge-Node Cluster raw status.
ClusterStatus_GetClusterRawStatus 2 params → 200400401403404409412500
GET
/v1/cluster/id/{id}/status
Get Edge-Node Cluster status.
ClusterStatus_GetClusterStatus 2 params → 200400401403404409412500
GET
/v1/cluster/id/{id}/upgrade/status
Get Edge-Node Cluster upgrade status.
ClusterStatus_GetClusterUpgradeStatus 2 params → 200400401403404409412500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ZsrvResponse (15 properties), infoKubeVolumeInfo (10 properties), infoKubeNodeInfo (9 properties), infoKubeEVEAppPodInfo (7 properties). Each schema is shown below with its type and property counts.

infoKubeEVEAppPodInfo
object
7 properties
ZcOpsType
string
ObjectType
string
infoErrorInfo
object
5 properties
infoKubeComp
string
KubeComp is a component installed in eve after usb install. These are provided to show more detail on cluster update progress.
EdgeNodeClusterRawInfo
object
2 properties
eveinfoSeverity
string
infoKubeVMIInfo
object
6 properties
infoStorageVolumeState
string
eveinfoEntity
string
- ENTITYUNSPECIFIED: Invalid Device Entity - ENTITYBASEOS: Base OS entity - ENTITYSYSTEMADAPTER: System Adapter Entity - ENTITYVAULT: Vault Entity - ENTITYATTE…
infoStorageVolumePVCStatus
string
protobufAny
object
2 properties
EdgeNodeClusterUpgradeStatusResp
object
1 property
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
infoKubeVolumeInfo
object
10 properties
infoKubePodNameSpaceInfo
object
6 properties
eveinfoDeviceEntity
object
3 properties
infoKubeNodeInfo
object
9 properties
infoKubePodStatus
string
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
EdgeNodeClusterUpgradeStatusRespNode
object
5 properties
infoNodeAdmission
string
- NODEADMISSIONNOTCLUSTERED: Not Clustered is the default state at first boot - NODEADMISSIONLEAVING: Leaving can be a long lived state due to draining existin…
EdgeNodeClusterStatus
object
2 properties
infoKubeNodeConditionType
string
infoStorageHealthStatus
string
StorageHealthStatus is a higher level tracking status to show redundancy/failure-zone level and rebuild progress.
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.
infoKubeCompUpdateStatus
string
KubeCompUpdateStatus will track status of each KubeComp which will update serially in a cluster.
EdgeNodeClusterUpgradeStatus
string
infoZInfoKubeClusterUpdateStatus
object
5 properties
infoKubeNodeCondition
object
3 properties
infoKubeVMIStatus
string
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
infoKubeStorageInfo
object
3 properties
infoKubeVolumeReplicaInfo
object
4 properties
infoZInfoKubeCluster
object
6 properties
infoServiceStatus
string
infoStorageVolumeRobustness
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-clusterstatus-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 DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API
Zededa EdgeDiagnostics API