gcp.gke.cluster.describe ​
Describe one GKE cluster by project, location, and name.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | Base-gcp |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | GCP CloudConnection UUID. |
project_id | string | No | — | GCP project override; defaults to the connection project. |
location | string | Yes | — | GKE region or zone. |
name | string | Yes | — | Cluster name. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | GCP CloudConnection UUID echoed from input. |
project_id | string | No | — | Effective GCP project. |
authenticated_project_id | string | No | — | Project resolved by credential validation. |
auth_validation | boolean | No | — | True when credential validation succeeded. |
location | string | No | — | GKE region or zone used. |
name | string | No | — | Cluster name. |
provider_resource_id | string | No | — | projects/{project}/locations/{location}/clusters/{name}. |
status | string | No | — | GKE cluster status. |
endpoint | string | No | — | Kubernetes API endpoint host or address. |
api_server | string | No | — | Normalized Kubernetes API server URL. |
master_version | string | No | — | Current master version. |
current_master_version | string | No | — | Current master version returned by GKE. |
current_node_count | integer | No | — | Current cluster node count. |
node_pools | list | No | — | Sanitized node pool summaries. |
conditions | list | No | — | Provider cluster conditions. |
network | string | No | — | Cluster network reference. |
subnetwork | string | No | — | Cluster subnetwork reference. |
resource_labels | json | No | — | Cluster labels. |
cluster | json | No | — | Sanitized provider cluster response. |
exists | boolean | No | — | True when the cluster was found. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Engine failed layer. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | preflight | — |
executing | No | No | — | complete | — |
preflighting | No | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | preflight | preflighting | — |
preflighting | execute | executing | — |
executing | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "gcp.gke.cluster.describe",
"initial_data": {
"connection_uuid": "value",
"location": "value",
"name": "value"
}
}