Skip to content
Proud to collaborate with Microsoft for Startups

cluster.refresh-status ​

Refresh and persist the normalized status snapshot for a logical cluster.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation.
cluster_uuiduuidYes—Logical cluster UUID to refresh.
connection_uuiduuidNo—Kubernetes CloudConnection UUID override.
providerstringNo—Provider key override used when the Cluster row is incomplete.
cluster_kindstringNo—Cluster kind override used when the Cluster row is incomplete.
provider_connection_uuiduuidNo—Provider CloudConnection UUID override used when the Cluster row is incomplete.
provider_cluster_refstringNo—Provider-side cluster identifier override.
regionstringNo—Primary provider region or location override.
provider_configjsonNo—Provider-specific status inputs override.
node_configjsonNo—Provider-specific node pool or nodegroup identifiers override.
include_snapshotbooleanNo—Whether to collect k8s.cluster.snapshot.
namespacesjsonNo—Optional namespaces filter for snapshot.
kindsjsonNo—Optional resource kinds filter for snapshot.
label_selectorstringNo—Optional label selector for snapshot.
actorstringNo—Caller or scheduler identity.
timeout_secondsintegerNo—Provider status timeout.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
cluster_uuiduuidNo—Logical cluster UUID.
connection_uuiduuidNo—Kubernetes CloudConnection UUID.
providerstringNo—Provider key override used when the Cluster row is incomplete.
cluster_kindstringNo—Cluster kind override used when the Cluster row is incomplete.
provider_connection_uuiduuidNo—Provider CloudConnection UUID override used when the Cluster row is incomplete.
provider_cluster_refstringNo—Provider-side cluster identifier override.
regionstringNo—Primary provider region or location override.
provider_configjsonNo—Provider-specific status inputs override.
node_configjsonNo—Provider-specific node pool or nodegroup identifiers override.
include_snapshotbooleanNo—Whether to collect k8s.cluster.snapshot.
namespacesjsonNo—Optional namespaces filter for snapshot.
kindsjsonNo—Optional resource kinds filter for snapshot.
label_selectorstringNo—Optional label selector for snapshot.
timeout_secondsintegerNo—Provider status timeout.
clusterjsonNo—Output from data.cluster.get.
status_resultjsonNo—Output from cluster.status.
cluster_snapshotjsonNo—Output from k8s.cluster.snapshot when requested.
statusstringNo—Persisted normalized status.
phasestringNo—Persisted provider phase.
reachablebooleanNo—Persisted Kubernetes reachability flag.
server_versionstringNo—Persisted Kubernetes API server version.
snapshot_atstringNo—Snapshot timestamp when collected.
persistedbooleanNo—True when status was persisted.
refreshed_atstringNo—ISO refresh timestamp.
actorstringNo—Caller or scheduler identity.
failure_reasonstringNo—Human-readable failure reason.
failure_typestringNo—Failure category.
failed_actionstringNo—Action that failed.
failed_stepjsonNo—Failed logical step or child workflow.
failed_layerjsonNo—Engine failed layer when applicable.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—load_cluster—
loading_clusterNoNo—read_status—
persisting_statusNoNo—complete—
reading_statusNoNo—persist_status—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingload_clusterloading_cluster—
loading_clusterread_statusreading_status—
reading_statuspersist_statuspersisting_status—
persisting_statuscompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "cluster.refresh-status",
  "initial_data": {
    "organization_uuid": "value",
    "cluster_uuid": "value"
  }
}