Usage Resources Functions
Package: DBMS_CLOUD_OCI_US_RESOURCES
LIST_RESOURCE_QUOTA Function
Returns the resource quota details under a tenancy > **Important**: Calls to this API will only succeed against the endpoint in the home region.
Syntax
FUNCTION list_resource_quota (
service_name varchar2,
compartment_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
service_entitlement varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_resources_list_resource_quota_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Service Name. |
|
(required) The OCID of the root compartment. |
|
(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
(optional) Service entitlement Id. |
|
(optional) The value of the 'opc-next-page' response header from the previous call. |
|
(optional) The maximum number of items to return in the paginated response. |
|
(optional) The sort order to use, which can be ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Supports one sort order. Allowed values are: 'TIMECREATED', 'TIMESTART' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_RESOURCES Function
Returns the resource details for a service > **Important**: Calls to this API will only succeed against the endpoint in the home region.
Syntax
FUNCTION list_resources (
service_name varchar2,
compartment_id varchar2,
entitlement_id varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
page varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_us_resources_list_resources_response_t;
Parameters
Parameter | Description |
---|---|
|
(required) Service Name. |
|
(required) The OCID of the root compartment. |
|
(optional) Subscription or entitlement Id. |
|
(optional) Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
(optional) The value of the 'opc-next-page' response header from the previous call. |
|
(optional) The maximum number of items to return in the paginated response. |
|
(optional) The sort order to use, which can be ascending (ASC) or descending (DESC). Allowed values are: 'ASC', 'DESC' |
|
(optional) The field to sort by. Supports one sort order. Allowed values are: 'TIMECREATED', 'TIMESTART' |
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
(optional) The endpoint of the service to call using this function. e.g https://identity.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |