OccMetricsClient

class oci.oci_control_center.OccMetricsClient(config, **kwargs)

OCI Control Center (OCC) service enables you to monitor the region-level cloud consumption and provides the region-level capacity data, in realms where OCC is available. Use the OCI Control Center (OCC) API to explore region-level capacity and utilization information about core services. For more information, see [OCI Control Center](/iaas/Content/control-center/home.htm).

Methods

__init__(config, **kwargs) Creates a new service client
list_metric_properties(namespace_name, …) Returns a list of available metrics for the given namespace.
list_namespaces(compartment_id, **kwargs) List all the available source services called namespaces emitting metrics for this region.
request_summarized_metric_data(…) Returns the summarized data for the given metric from the given namespace.
__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.
list_metric_properties(namespace_name, compartment_id, **kwargs)

Returns a list of available metrics for the given namespace. The results for metrics with dimensions includes list of all the associated dimensions. The results are sorted by the metricName and then by dimension in ascending alphabetical order. For a list of valid namespaces, see list_namespaces().

Parameters:
  • namespace_name (str) – (required) The name of the source service emitting the metric.
  • compartment_id (str) – (required) The OCID of the compartment to use for authorization. To use the root compartment, provide the tenancyId.
  • page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see <a href=”https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine”>List Pagination</a>.
  • limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
  • opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete 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 MetricPropertyCollection
Return type:

Response
Example:

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

list_namespaces(compartment_id, **kwargs)

List all the available source services called namespaces emitting metrics for this region. The namespaces are sorted in ascending alphabetical order.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment to use for authorization. To use the root compartment, provide the tenancyId.
  • page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see <a href=”https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine”>List Pagination</a>.
  • limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
  • opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete 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 NamespaceCollection
Return type:

Response
Example:

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

request_summarized_metric_data(request_summarized_metric_data_details, **kwargs)

Returns the summarized data for the given metric from the given namespace. The aggregation method depends on the metric. The metric data can be filtered by providing the dimension, startTime or endTime. The metric data in the response is sorted by dimension in ascending order and then by sampleTime in ascending chronological order.

Parameters:
  • request_summarized_metric_data_details (oci.oci_control_center.models.RequestSummarizedMetricDataDetails) – (required) Filters to apply to the metric data query
  • page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see <a href=”https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine”>List Pagination</a>.
  • limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
  • opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete 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 SummarizedMetricDataCollection
Return type:

Response
Example:

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