Skip to content
Proud to collaborate with Microsoft for Startups

gcp.compute.network.describe ​

Describe a GCP VPC network by name or self link.

Overview ​

PropertyValue
Workflow typeLinear
LibraryBase-gcp
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—GCP CloudConnection UUID.
project_idstringNo—GCP project ID override.
namestringYes—VPC network name or self link.
regionstringNo—Optional region used for credential scoping.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—GCP CloudConnection UUID.
project_idstringNo—GCP project ID override.
namestringNo—VPC network name or self link.
regionstringNo—Optional region used for credential scoping.
existsbooleanNo—Whether the network exists.
self_linkstringNo—Network self link.
network_idstringNo—Provider network identifier.
auto_create_subnetworksbooleanNo—Whether auto subnet creation is enabled.
routing_modestringNo—Dynamic routing mode.
networkjsonNo—Sanitized Compute Network response.
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.

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.compute.network.describe",
  "initial_data": {
    "connection_uuid": "value",
    "name": "value"
  }
}