ingest_budgets_v2

Overview

Name	ingest_budgets_v2
Type	Resource
Id	sumologic.ingest_budgets.ingest_budgets_v2

Fields

Name	Datatype	Description
id	string	Unique identifier for the ingest budget.
name	string	Display name of the ingest budget.
description	string	Description of the ingest budget.
action	string	Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are: stopCollecting keepCollecting
auditThreshold	integer	The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
budgetVersion	integer	The version of the Ingest Budget
capacityBytes	integer	Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit.
createdAt	string	The creation timestamp in UTC of the Ingest Budget.
createdBy	string	The identifier of the user who created the Ingest Budget.
modifiedAt	string	The modified timestamp in UTC of the Ingest Budget.
modifiedBy	string	The identifier of the user who modified the Ingest Budget.
resetTime	string	Reset time of the ingest budget in HH:MM format.
scope	string	A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. Value supports wildcard. e.g. _sourceCategory=prodpayment, cluster=kafka. If the scope is defined _sourceCategory=nginx* in this budget will be applied on messages having fields _sourceCategory=prod/nginx, _sourceCategory=dev/nginx, or _sourceCategory=dev/nginx/error
timezone	string	Time zone of the reset time for the ingest budget. Follow the format in the IANA Time Zone Database.
usageBytes	integer	Current usage since the last reset, in bytes.
usageStatus	string	Status of the current usage. Can be Normal, Approaching, Exceeded, or Unknown (unable to retrieve usage).

Methods

Name	Accessible by	Required Params	Description
getIngestBudgetV2	SELECT	id, region	Get an ingest budget by the given identifier.
listIngestBudgetsV2	SELECT	region	Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page.
createIngestBudgetV2	INSERT	data__action, data__capacityBytes, data__name, data__resetTime, data__scope, data__timezone, region	Create a new ingest budget.
deleteIngestBudgetV2	DELETE	id, region	Delete an ingest budget with the given identifier.
updateIngestBudgetV2	EXEC	id, data__action, data__capacityBytes, data__name, data__resetTime, data__scope, data__timezone, region	Update an existing ingest budget. All properties specified in the request are required.