Budget Functions

CREATE_ALERT_RULE Function

Creates a new Alert Rule.

Syntax

FUNCTION create_alert_rule (
  budget_id varchar2,
  create_alert_rule_details dbms_cloud_oci_budget_create_alert_rule_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_create_alert_rule_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`create_alert_rule_details`	(required) Details for the new Alert Rule.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BUDGET Function

Creates a new budget.

Syntax

FUNCTION create_budget (
  create_budget_details dbms_cloud_oci_budget_create_budget_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_create_budget_response_t;

Parameters

Parameter	Description
`create_budget_details`	(required) Details for the new budget.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ALERT_RULE Function

Deletes a specified Alert Rule resource.

Syntax

FUNCTION delete_alert_rule (
  budget_id varchar2,
  alert_rule_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_delete_alert_rule_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`alert_rule_id`	(required) The unique Alert Rule OCID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BUDGET Function

Deletes a specified budget resource.

Syntax

FUNCTION delete_budget (
  budget_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_delete_budget_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ALERT_RULE Function

Gets an Alert Rule for a specified budget.

Syntax

FUNCTION get_alert_rule (
  budget_id varchar2,
  alert_rule_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_get_alert_rule_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`alert_rule_id`	(required) The unique Alert Rule OCID.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BUDGET Function

Gets a budget by the identifier.

Syntax

FUNCTION get_budget (
  budget_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_get_budget_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ALERT_RULES Function

Returns a list of Alert Rules for a specified budget.

Syntax

FUNCTION list_alert_rules (
  budget_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_list_alert_rules_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order. Allowed values are: 'timeCreated', 'displayName'
`lifecycle_state`	(optional) The current state of the resource to filter by. Allowed values are: 'ACTIVE', 'INACTIVE'
`display_name`	(optional) A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource`
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BUDGETS Function

Gets a list of budgets in a compartment. By default, ListBudgets returns budgets of the 'COMPARTMENT' target type, and the budget records with only one target compartment OCID. To list all budgets, set the targetType query parameter to ALL (for example: 'targetType=ALL'). Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.

Syntax

FUNCTION list_budgets (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  target_type varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_list_budgets_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of the compartment in which to list resources.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order. Allowed values are: 'timeCreated', 'displayName'
`lifecycle_state`	(optional) The current state of the resource to filter by. Allowed values are: 'ACTIVE', 'INACTIVE'
`display_name`	(optional) A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource`
`target_type`	(optional) The type of target to filter by: * ALL - List all budgets * COMPARTMENT - List all budgets with targetType == \"COMPARTMENT\" * TAG - List all budgets with targetType == \"TAG\" Allowed values are: 'ALL', 'COMPARTMENT', 'TAG'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ALERT_RULE Function

Update an Alert Rule for the budget identified by the OCID.

Syntax

FUNCTION update_alert_rule (
  budget_id varchar2,
  alert_rule_id varchar2,
  update_alert_rule_details dbms_cloud_oci_budget_update_alert_rule_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_update_alert_rule_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`alert_rule_id`	(required) The unique Alert Rule OCID.
`update_alert_rule_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BUDGET Function

Update a budget identified by the OCID.

Syntax

FUNCTION update_budget (
  budget_id varchar2,
  update_budget_details dbms_cloud_oci_budget_update_budget_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bd_budget_update_budget_response_t;

Parameters

Parameter	Description
`budget_id`	(required) The unique budget OCID.
`update_budget_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://usage.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CREATE_ALERT_RULE Function 🔗

CREATE_BUDGET Function 🔗

DELETE_ALERT_RULE Function 🔗

DELETE_BUDGET Function 🔗

GET_ALERT_RULE Function 🔗

GET_BUDGET Function 🔗

LIST_ALERT_RULES Function 🔗

LIST_BUDGETS Function 🔗

UPDATE_ALERT_RULE Function 🔗

UPDATE_BUDGET Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_ALERT_RULE Function

CREATE_BUDGET Function

DELETE_ALERT_RULE Function

DELETE_BUDGET Function

GET_ALERT_RULE Function

GET_BUDGET Function

LIST_ALERT_RULES Function

LIST_BUDGETS Function

UPDATE_ALERT_RULE Function

UPDATE_BUDGET Function