LimitsClient¶

class oci.limits.LimitsClient(config, **kwargs)¶

APIs that interact with the resource limits of a specific resource type.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`get_resource_availability`(service_name, …)	For a given compartmentId, resource limit name, and scope, returns the following: * The number of available resources associated with the given limit.
`list_limit_definitions`(compartment_id, **kwargs)	Includes a list of resource limits that are currently supported.
`list_limit_values`(compartment_id, …)	Includes a full list of resource limits belonging to a given service.
`list_services`(compartment_id, **kwargs)	Returns the list of supported services.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

get_resource_availability(service_name, limit_name, compartment_id, **kwargs)¶

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.

If Subscription Id is provided, then usage for resource created in that subscription will be returned Note that not all resource limits support this API. If the value is not available, the API returns a 404 response.

Parameters:	service_name (str) – (required) The service name of the target quota. limit_name (str) – (required) The limit name for which to fetch the data. compartment_id (str) – (required) The OCID of the compartment for which data is being fetched. availability_domain (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. subscription_id (str) – (optional) The OCID of the subscription assigned to tenant retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ResourceAvailability`
Return type:	`Response`
Example:

Click here to see an example of how to use get_resource_availability API.

list_limit_definitions(compartment_id, **kwargs)¶

Includes a list of resource limits that are currently supported. If subscription Id is provided, then only resource limits supported by subscription will be returned If the ‘areQuotasSupported’ property is true, you can create quota policies on top of this limit at the compartment level.

Parameters:	compartment_id (str) – (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). subscription_id (str) – (optional) The OCID of the subscription assigned to tenant service_name (str) – (optional) The target service name. name (str) – (optional) Optional field, filter for a specific resource limit. sort_by (str) – (optional) The field to sort by. Allowed values are: “name”, “description” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. By default, it is ascending. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `LimitDefinitionSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_limit_definitions API.

list_limit_values(compartment_id, service_name, **kwargs)¶

Includes a full list of resource limits belonging to a given service. If subscription Id is provided, limit value for subscription will be returned.

Parameters:	compartment_id (str) – (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). service_name (str) – (required) The target service name. subscription_id (str) – (optional) The OCID of the subscription assigned to tenant scope_type (str) – (optional) Filter entries by scope type. Allowed values are: “GLOBAL”, “REGION”, “AD” availability_domain (str) – (optional) Filter entries by availability domain. This implies that only AD-specific values are returned. name (str) – (optional) Optional field, can be used to see a specific resource limit value. sort_by (str) – (optional) The field to sort by. The sorting is by availabilityDomain, as a second level field, if available. Allowed values are: “name” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. By default, it is ascending. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `LimitValueSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_limit_values API.

list_services(compartment_id, **kwargs)¶

Returns the list of supported services. If subscription ID is provided then only services supported by subscription will be returned. This includes the programmatic service name, along with the friendly service name.

Parameters:	compartment_id (str) – (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). sort_by (str) – (optional) The field to sort by. Allowed values are: “name”, “description” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. By default, it is ascending. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return in a paginated “List” call. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. subscription_id (str) – (optional) The OCID of the subscription assigned to tenant retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ServiceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_services API.