gcp.compute.instance_group_manager.describe ​
Describe a GCE managed instance group (current/target size, template, status).
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. |
zone | string | No | — | Zone of a zonal managed instance group; mutually exclusive with region. |
region | string | No | — | Region of a regional managed instance group; mutually exclusive with zone. |
name | string | Yes | — | Managed instance group 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. |
zone | string | No | — | Zone of the managed instance group echoed from input. |
region | string | No | — | Region of the managed instance group echoed from input. |
name | string | No | — | Managed instance group name echoed from input. |
exists | boolean | No | — | True when the managed instance group was found. |
provider_resource_id | string | No | — | projects/{project}/zones |
self_link | string | No | — | Provider selfLink of the managed instance group. |
instance_template | string | No | — | Instance template currently in use by the group. |
target_size | integer | No | — | Target number of instances for the group. |
current_size | integer | No | — | Current number of instances in the group. |
base_instance_name | string | No | — | Base name used for instances created by the group. |
status | json | No | — | Provider status block for the managed instance group. |
named_ports | json | No | — | Named ports configured on the managed instance group. |
current_actions | json | No | — | Provider currentActions summary (creating, deleting, ...). |
instance_group_manager | json | No | — | Sanitized provider instanceGroupManager resource. |
failure_reason | string | No | — | Human-readable failure reason. |
failure_type | string | No | — | Engine exception class. |
failure_category | string | No | — | Provider failure category. |
failure_details | json | No | — | Structured provider failure details. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Engine failed layer. |
failed_at_state | string | No | — | State where failure occurred. |
failed_action | string | No | — | Failed transition action. |
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 | — |
creating | 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 | creating | — |
creating | complete | completed | — |
* (any state) | fail | failed | — |
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"
}
}