REST Resource: billingAccounts.budgets

Resource: Budget

A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).

JSON representation
{
  "name": string,
  "displayName": string,
  "budgetFilter": {
    object (Filter)
  },
  "amount": {
    object (BudgetAmount)
  },
  "thresholdRules": [
    {
      object (ThresholdRule)
    }
  ],
  "allUpdatesRule": {
    object (AllUpdatesRule)
  },
  "etag": string
}
Fields
name

string

Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

displayName

string

User data for display name in UI. Validation: <= 60 chars.

budgetFilter

object (Filter)

Optional. Filters that define which resources are used to compute the actual spend against the budget.

amount

object (BudgetAmount)

Required. Budgeted amount.

thresholdRules[]

object (ThresholdRule)

Required. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.

allUpdatesRule

object (AllUpdatesRule)

Optional. Rules to apply to all updates to the actual spend, regardless of the thresholds set in thresholdRules.

etag

string

Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

Filter

A filter for a budget, limiting the scope of the cost to calculate.

JSON representation
{
  "projects": [
    string
  ],
  "creditTypesTreatment": enum (CreditTypesTreatment),
  "services": [
    string
  ]
}
Fields
projects[]

string

Optional. A set of projects of the form projects/{project_id}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.

creditTypesTreatment

enum (CreditTypesTreatment)

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

services[]

string

Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

CreditTypesTreatment

Specifies how credits should be treated when determining spend for threshold calculations.

Enums
CREDIT_TYPES_TREATMENT_UNSPECIFIED
INCLUDE_ALL_CREDITS All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.
EXCLUDE_ALL_CREDITS All types of credit are added to the net cost to determine the spend for threshold calculations.

BudgetAmount

The budgeted amount for each usage period.

JSON representation
{

  // Union field budget_amount can be only one of the following:
  "specifiedAmount": {
    object (Money)
  },
  "lastPeriodAmount": {
    object (LastPeriodAmount)
  }
  // End of list of possible types for union field budget_amount.
}
Fields
Union field budget_amount. Specification for what amount to use as the budget. budget_amount can be only one of the following:
specifiedAmount

object (Money)

A specified amount to use as the budget. currencyCode is optional. If specified, it must match the currency of the billing account. The currencyCode is provided on output.

lastPeriodAmount

object (LastPeriodAmount)

Use the last period's actual spend as the budget for the present period.

Money

Represents an amount of money with its currency type.

JSON representation
{
  "currencyCode": string,
  "units": string,
  "nanos": number
}
Fields
currencyCode

string

The 3-letter currency code defined in ISO 4217.

units

string (int64 format)

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

nanos

number

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

LastPeriodAmount

Describes a budget amount targeted to last period's spend. At this time, the amount is automatically 100% of last period's spend; that is, there are no other options yet. Future configuration will be described here (for example, configuring a percentage of last period's spend).

ThresholdRule

ThresholdRule contains a definition of a threshold which triggers an alert (a notification of a threshold being crossed) to be sent when spend goes above the specified amount. Alerts are automatically e-mailed to users with the Billing Account Administrator role or the Billing Account User role. The thresholds here have no effect on notifications sent to anything configured under Budget.all_updates_rule.

JSON representation
{
  "thresholdPercent": number,
  "spendBasis": enum (Basis)
}
Fields
thresholdPercent

number

Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

spendBasis

enum (Basis)

Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

Basis

The type of basis used to determine if spend has passed the threshold.

Enums
BASIS_UNSPECIFIED Unspecified threshold basis.
CURRENT_SPEND Use current spend as the basis for comparison against the threshold.
FORECASTED_SPEND Use forecasted spend for the period as the basis for comparison against the threshold.

AllUpdatesRule

AllUpdatesRule defines notifications that are sent on every update to the billing account's spend, regardless of the thresholds defined using threshold rules.

JSON representation
{
  "pubsubTopic": string,
  "schemaVersion": string
}
Fields
pubsubTopic

string

Required. The name of the Cloud Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/pubsub/docs/access-control for more details on Pub/Sub roles and permissions.

schemaVersion

string

Required. The schema version of the notification. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets#notification_format

Methods

create

Creates a new budget.

delete

Deletes a budget.

get

Returns a budget.

list

Returns a list of budgets for a billing account.

patch

Updates a budget and returns the updated budget.
¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Si necesitas ayuda, visita nuestra página de asistencia.