Limits Functions

Package: DBMS_CLOUD_OCI_LM_LIMITS

GET_RESOURCE_AVAILABILITY Function

For a given compartmentId, resource limit name, and scope, returns the following: * The number of available resources associated with the given limit. * The usage in the selected compartment for the given limit. Note that not all resource limits support this API. If the value is not available, the API returns a 404 response.

Syntax

FUNCTION get_resource_availability (
  service_name varchar2,
  limit_name varchar2,
  compartment_id varchar2,
  availability_domain 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_limits_get_resource_availability_response_t;

Parameters

Parameter	Description
`service_name`	(required) The service name of the target quota.
`limit_name`	(required) The limit name for which to fetch the data.
`compartment_id`	(required) The OCID of the compartment for which data is being fetched.
`availability_domain`	(optional) This field is mandatory if the scopeType of the target resource limit is AD. Otherwise, this field should be omitted. If the above requirements are not met, the API returns a 400 - InvalidParameter response.
`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_LIMIT_DEFINITIONS Function

Includes a list of resource limits that are currently supported. If the 'areQuotasSupported' property is true, you can create quota policies on top of this limit at the compartment level.

Syntax

FUNCTION list_limit_definitions (
  compartment_id varchar2,
  service_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_limits_list_limit_definitions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
`service_name`	(optional) The target service name.
`name`	(optional) Optional field, filter for a specific resource limit.
`sort_by`	(optional) The field to sort by. Allowed values are: 'name', 'description'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. By default, it is ascending. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`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_LIMIT_VALUES Function

Includes a full list of resource limits belonging to a given service.

Syntax

FUNCTION list_limit_values (
  compartment_id varchar2,
  service_name varchar2,
  scope_type varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_limits_list_limit_values_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
`service_name`	(required) The target service name.
`scope_type`	(optional) Filter entries by scope type. Allowed values are: 'GLOBAL', 'REGION', 'AD'
`availability_domain`	(optional) Filter entries by availability domain. This implies that only AD-specific values are returned.
`name`	(optional) Optional field, can be used to see a specific resource limit value.
`sort_by`	(optional) The field to sort by. The sorting is by availabilityDomain, as a second level field, if available. Allowed values are: 'name'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. By default, it is ascending. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`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_SERVICES Function

Returns the list of supported services. This includes the programmatic service name, along with the friendly service name.

Syntax

FUNCTION list_services (
  compartment_id varchar2,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page 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_limits_list_services_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
`sort_by`	(optional) The field to sort by. Allowed values are: 'name', 'description'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. By default, it is ascending. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`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.

Oracle Cloud Infrastructure Documentation Try Free Tier

GET_RESOURCE_AVAILABILITY Function 🔗

LIST_LIMIT_DEFINITIONS Function 🔗

LIST_LIMIT_VALUES Function 🔗

LIST_SERVICES Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

GET_RESOURCE_AVAILABILITY Function

LIST_LIMIT_DEFINITIONS Function

LIST_LIMIT_VALUES Function

LIST_SERVICES Function