Skip to main content

list-budgets 

restish dci list-budgets [flags]

Returns a list of budgets that your account has access to. Budgets are listed in reverse chronological order by default.

Flags​

--max-results: (string default:"50")

--page-token: (string)

--filter: (string)

--min-creation-time: (string)

--max-creation-time: (string)

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "type": "object",
  "properties": {
    "budgets": {
      "type": "array",
      "description": "Array of Budgets",
      "items": {
        "type": "object",
        "properties": {
          "alertThresholds": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "number",
                  "format": "double"
                },
                "percentage": {
                  "type": "number",
                  "format": "double"
                }
              }
            }
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "budgetName": {
            "type": "string"
          },
          "createTime": {
            "type": "integer",
            "format": "int64"
          },
          "currency": {
            "type": "string"
          },
          "currentUtilization": {
            "type": "number",
            "format": "double"
          },
          "endPeriod": {
            "type": "integer",
            "format": "int64"
          },
          "forecastedUtilizationDate": {
            "type": "integer",
            "format": "int64"
          },
          "id": {
            "type": "string"
          },
          "owner": {
            "type": "string"
          },
          "scope": {
            "type": "array",
            "description": "List of attributions that define the budget scope.",
            "items": {
              "type": "string"
            },
            "deprecated": true
          },
          "scopes": {
            "type": "array",
            "description": "The filters selected define the scope of the budget.",
            "items": {
              "description": "To filter or exclude certain values by type.\nWhen using attributions as a filter, both the type and the ID must be \"attribution\", and the values array contains the attribution IDs.",
              "type": "object",
              "required": [
                "id",
                "type",
                "mode"
              ],
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The field to filter on"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "datetime",
                    "fixed",
                    "optional",
                    "label",
                    "tag",
                    "project_label",
                    "system_label",
                    "attribution",
                    "attribution_group",
                    "gke",
                    "gke_label"
                  ]
                },
                "mode": {
                  "type": "string",
                  "description": "Filter mode to apply",
                  "enum": [
                    "is",
                    "starts_with",
                    "ends_with",
                    "contains",
                    "regexp"
                  ]
                },
                "inverse": {
                  "type": "boolean",
                  "description": "Set to `true` to exclude the values."
                },
                "values": {
                  "type": "array",
                  "description": "Values to filter on",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "example": {
                "id": "cloud_provider",
                "type": "fixed",
                "inverse": false,
                "values": [
                  "google-cloud"
                ]
              }
            }
          },
          "startPeriod": {
            "type": "integer",
            "format": "int64"
          },
          "timeInterval": {
            "type": "string"
          },
          "updateTime": {
            "type": "integer",
            "format": "int64"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "pageToken": {
      "type": "string",
      "description": "Page token, returned by a previous call, to request the next page of results"
    },
    "rowCount": {
      "type": "integer",
      "description": "Budgets rows count",
      "format": "int64"
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-budgets, listbudgets