Appearance
cluster.status-gcp-vm ​
Return provider status for a GCP VM-backed cluster.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-clusters-gcp |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
provider_connection_uuid | uuid | Yes | — | — |
provider_cluster_ref | string | Yes | — | — |
project_id | string | No | — | — |
zone | string | Yes | — | — |
actor | string | No | — | — |
timeout_seconds | integer | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | — |
provider_connection_uuid | uuid | Yes | — | — |
provider_cluster_ref | string | Yes | — | — |
project_id | string | No | — | — |
zone | string | Yes | — | — |
actor | string | No | — | — |
timeout_seconds | integer | No | — | — |
describe_vm | json | No | — | — |
provider_status | json | No | — | — |
status | string | No | — | — |
phase | string | No | — | — |
reachable | boolean | No | — | — |
private_ip | string | No | — | — |
public_ip | string | No | — | — |
checked_at | string | No | — | — |
failure_reason | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | describe_vm | — |
describing_vm | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | describe_vm | describing_vm | — |
describing_vm | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "cluster.status-gcp-vm",
"initial_data": {
"provider_connection_uuid": "value",
"provider_cluster_ref": "value",
"zone": "value"
}
}