Skip to content
Proud to collaborate with Microsoft for Startups

gcp.compute.instance_group_manager.describe ​

Describe a GCE managed instance group (current/target size, template, status).

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.
zonestringNo—Zone of a zonal managed instance group; mutually exclusive with region.
regionstringNo—Region of a regional managed instance group; mutually exclusive with zone.
namestringYes—Managed instance group 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.
zonestringNo—Zone of the managed instance group echoed from input.
regionstringNo—Region of the managed instance group echoed from input.
namestringNo—Managed instance group name echoed from input.
existsbooleanNo—True when the managed instance group was found.
provider_resource_idstringNo—projects/{project}/zones
self_linkstringNo—Provider selfLink of the managed instance group.
instance_templatestringNo—Instance template currently in use by the group.
target_sizeintegerNo—Target number of instances for the group.
current_sizeintegerNo—Current number of instances in the group.
base_instance_namestringNo—Base name used for instances created by the group.
statusjsonNo—Provider status block for the managed instance group.
named_portsjsonNo—Named ports configured on the managed instance group.
current_actionsjsonNo—Provider currentActions summary (creating, deleting, ...).
instance_group_managerjsonNo—Sanitized provider instanceGroupManager resource.
failure_reasonstringNo—Human-readable failure reason.
failure_typestringNo—Engine exception class.
failure_categorystringNo—Provider failure category.
failure_detailsjsonNo—Structured provider failure details.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer.
failed_at_statestringNo—State where failure occurred.
failed_actionstringNo—Failed transition action.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

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

State Diagram ​

Transitions ​

FromActionToDescription
pendingpreflightpreflighting—
preflightingexecutecreating—
creatingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "gcp.compute.instance_group_manager.describe",
  "initial_data": {
    "connection_uuid": "value",
    "name": "value"
  }
}