Skip to content
Proud to collaborate with Microsoft for Startups

mgc.compute.list_instances ​

List Magalu Cloud virtual machines for a connection (via LTIP).

Overview ​

PropertyValue
Workflow typeAtomic
LibraryBase-mgc
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—CloudConnection UUID for the target Magalu account.
workflow_run_idstringNo—Engine DAG run ID stamped onto child steps.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID echoed from input.
instanceslistNo—Virtual machines ({instance_uuid,name,status,instance_type,public_ip,private_ip}).
countintegerNo—Number of instances returned.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerstringNo—DAG layer where failure occurred.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "mgc.compute.list_instances",
  "initial_data": {
    "connection_uuid": "value"
  }
}