Skip to content
Proud to collaborate with Microsoft for Startups

gcp.gke.cluster.describe ​

Describe one GKE cluster by project, location, and name.

Overview ​

PropertyValue
Workflow typeLinear
LibraryBase-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—GCP CloudConnection UUID.
project_idstringNo—GCP project override; defaults to the connection project.
locationstringYes—GKE region or zone.
namestringYes—Cluster name.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—GCP CloudConnection UUID echoed from input.
project_idstringNo—Effective GCP project.
authenticated_project_idstringNo—Project resolved by credential validation.
auth_validationbooleanNo—True when credential validation succeeded.
locationstringNo—GKE region or zone used.
namestringNo—Cluster name.
provider_resource_idstringNo—projects/{project}/locations/{location}/clusters/{name}.
statusstringNo—GKE cluster status.
endpointstringNo—Kubernetes API endpoint host or address.
api_serverstringNo—Normalized Kubernetes API server URL.
master_versionstringNo—Current master version.
current_master_versionstringNo—Current master version returned by GKE.
current_node_countintegerNo—Current cluster node count.
node_poolslistNo—Sanitized node pool summaries.
conditionslistNo—Provider cluster conditions.
networkstringNo—Cluster network reference.
subnetworkstringNo—Cluster subnetwork reference.
resource_labelsjsonNo—Cluster labels.
clusterjsonNo—Sanitized provider cluster response.
existsbooleanNo—True when the cluster was found.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—preflight—
executingNoNo—complete—
preflightingNoNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingpreflightpreflighting—
preflightingexecuteexecuting—
executingcompletecompleted—
* (any state)failfailed—

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"
  }
}