Skip to content
Proud to collaborate with Microsoft for Startups

gcp.gke.node_pool.describe ​

Describe one GKE node pool by project, location, cluster, and node-pool 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 cluster region or zone.
cluster_namestringYes—Parent cluster name.
namestringYes—Node pool 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 cluster region or zone.
cluster_namestringNo—Parent cluster name.
namestringNo—Node pool name.
provider_resource_idstringNo—Full provider node-pool resource path.
statusstringNo—GKE node-pool status.
status_messagestringNo—Provider status message
versionstringNo—Node pool Kubernetes version.
node_countintegerNo—Reported initial or desired node count.
instance_group_urlslistNo—Backing managed instance group URLs.
configjsonNo—Sanitized provider node config.
autoscalingjsonNo—Provider autoscaling settings.
managementjsonNo—Provider node management settings.
conditionslistNo—Provider node-pool conditions.
node_pooljsonNo—Sanitized provider node-pool response.
existsbooleanNo—True when the node pool 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.node_pool.describe",
  "initial_data": {
    "connection_uuid": "value",
    "location": "value",
    "cluster_name": "value",
    "name": "value"
  }
}