Limits Quotas Functions

Package: DBMS_CLOUD_OCI_LM_QUOTAS

ADD_QUOTA_LOCK Function

Adds a lock to a resource.

Syntax

FUNCTION add_quota_lock (
  quota_id varchar2,
  add_lock_details dbms_cloud_oci_limits_add_lock_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lm_quotas_add_quota_lock_response_t;

Parameters

Parameter	Description
`quota_id`	(required) The OCID of the quota.
`add_lock_details`	(required)
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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 is updated or deleted only if the etag you provide matches the resource's current etag value.
`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://limits.{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_QUOTA Function

Creates a new quota with the details supplied.

Syntax

FUNCTION create_quota (
  create_quota_details dbms_cloud_oci_limits_create_quota_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lm_quotas_create_quota_response_t;

Parameters

Parameter	Description
`create_quota_details`	(required) Request object for creating a new quota.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request can be rejected).
`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://limits.{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_QUOTA Function

Deletes the quota corresponding to the given OCID.

Syntax

FUNCTION delete_quota (
  quota_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lm_quotas_delete_quota_response_t;

Parameters

Parameter	Description
`quota_id`	(required) The OCID of the quota.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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 is updated or deleted only if the etag you provide matches the resource's current etag value.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://limits.{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_QUOTA Function

Gets the quota for the OCID specified.

Syntax

FUNCTION get_quota (
  quota_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_lm_quotas_get_quota_response_t;

Parameters

Parameter	Description
`quota_id`	(required) The OCID of the quota.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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://limits.{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_QUOTAS Function

Lists all quotas on resources from the given compartment.

Syntax

FUNCTION list_quotas (
  compartment_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by 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_lm_quotas_list_quotas_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`name`	(optional) name
`lifecycle_state`	(optional) Filters returned quotas based on the given state. Allowed values are: 'ACTIVE'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. By default, it is ascending. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. Time created is default ordered as descending. Display name is default ordered as ascending. Allowed values are: 'NAME', 'TIMECREATED'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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://limits.{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.

REMOVE_QUOTA_LOCK Function

Remove a lock from a resource.

Syntax

FUNCTION remove_quota_lock (
  quota_id varchar2,
  remove_lock_details dbms_cloud_oci_limits_remove_lock_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lm_quotas_remove_quota_lock_response_t;

Parameters

Parameter	Description
`quota_id`	(required) The OCID of the quota.
`remove_lock_details`	(required)
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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 is updated or deleted only if the etag you provide matches the resource's current etag value.
`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://limits.{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_QUOTA Function

Updates the quota corresponding to given OCID with the details supplied.

Syntax

FUNCTION update_quota (
  quota_id varchar2,
  update_quota_details dbms_cloud_oci_limits_update_quota_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  is_lock_override number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_lm_quotas_update_quota_response_t;

Parameters

Parameter	Description
`quota_id`	(required) The OCID of the quota.
`update_quota_details`	(required) Request object for updating a quota.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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 is updated or deleted only if the etag you provide matches the resource's current etag value.
`is_lock_override`	(optional) Whether to override locks (if any exist).
`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://limits.{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

Limits Quotas Functions

ADD_QUOTA_LOCK Function

CREATE_QUOTA Function

DELETE_QUOTA Function

GET_QUOTA Function

LIST_QUOTAS Function

REMOVE_QUOTA_LOCK Function

UPDATE_QUOTA Function