gcp.billing.budget.describe ​
Describe a billing budget.
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 for auth; defaults to the connection's project. |
billing_account_id | string | Yes | — | Billing account id or billingAccounts/* name. |
budget_id | string | Yes | — | Budget id or full billingAccounts//budgets/ name. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | Echoed connection UUID. |
project_id | string | No | — | Effective project id. |
billing_account_id | string | No | — | Billing account id or billingAccounts/* name. |
budget_id | string | No | — | Budget id or full billingAccounts//budgets/ name. |
budget_name | string | No | — | Full budget resource name billingAccounts//budgets/. |
display_name | string | No | — | Budget display name. |
budget | json | No | — | Sanitized Budget response. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Engine failed layer. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | preflight | — |
describing | 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 | describing | — |
describing | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "gcp.billing.budget.describe",
"initial_data": {
"connection_uuid": "value",
"billing_account_id": "value",
"budget_id": "value"
}
}