Oracle Occ Metrics API

openapi: 3.2.0
info:
  description: '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).

    '
  title: OCI Control Center Occ Metrics API
  version: '20230515'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/b193deba0def3a4cd1118a4ae93d1cb396bb86a2b51c6e4e560790de09e5e6bb.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OCI Control Center API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/b193deba0def3a4cd1118a4ae93d1cb396bb86a2b51c6e4e560790de09e5e6bb.yaml
    what: the harvested document for OCI Control Center API
servers:
- url: http://127.0.0.1/20230515
- url: https://127.0.0.1/20230515
tags:
- name: occMetrics
paths:
  /metricProperties/{namespaceName}:
    get:
      description: '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 API](#/en/occ/20230515/NamespaceCollection/ListNamespaces).

        '
      operationId: ListMetricProperties
      parameters:
      - $ref: '#/components/parameters/NamespaceName'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentId'
      responses:
        200:
          description: success
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this

                header appears in the response, then a partial list might have been

                returned. Include this value as the `page` parameter for the subsequent

                GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricPropertyCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: LIST available metrics (for a namespace)
      tags:
      - occMetrics
      x-example: 'GET /20230515/metricProperties/Compute?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: https://control-center.{region}.oci.{secondLevelDomain}

        <var>&lt;authorization and other headers&gt;</var>

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

        '
      operationId: ListNamespaces
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentId'
      responses:
        200:
          description: success
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this

                header appears in the response, then a partial list might have been

                returned. Include this value as the `page` parameter for the subsequent

                GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamespaceCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List available namespaces (services)
      tags:
      - occMetrics
      x-example: 'GET /20230515/namespaces?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: https://control-center.{region}.oci.{secondLevelDomain}

        <var>&lt;authorization and other headers&gt;</var>

        '
  /requestSummarizedMetricData:
    post:
      description: '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.

        '
      operationId: RequestSummarizedMetricData
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: success
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this

                header appears in the response, then a partial list might have been

                returned. Include this value as the `page` parameter for the subsequent

                GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummarizedMetricDataCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Requests summarized data for a metric
      tags:
      - occMetrics
      x-example: "POST /20230515/requestSummarizedMetricData\nHost: https://control-center.{region}.oci.{secondLevelDomain}\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"metricName\": \"AVAILABLE_CORES\",\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleId\",\n  \"namespaceName\": \"Compute\",\n  \"dimensions\": {\n    \"service_type\": {\n      \"dimensionValue\": \"Std Intel\"\n    },\n    \"pool_name\": {\n      \"dimensionValue\": \"compute_standard\"\n    }\n  }\n}\n"
      x-obmcs-large-response-payload: true
      x-related-resource: '#/definitions/SummarizedMetricDataCollection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestSummarizedMetricDataDetails'
        description: Filters to apply to the metric data query
        required: true
components:
  schemas:
    NamespaceCollection:
      description: 'The list of source services called namespaces emitting metrics that you can explore using OCI Control Center.

        '
      properties:
        items:
          description: 'An array of NamespaceSummary objects.

            '
          items:
            $ref: '#/components/schemas/NamespaceSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"namespaceName\": \"Block Storage\"\n    },\n    {\n      \"namespaceName\": \"Compute\"\n    },\n    {\n      \"namespaceName\": \"Exadata\"\n    },\n    {\n      \"namespaceName\": \"File Storage Service\"\n    },\n    {\n      \"namespaceName\": \"Object Storage\"\n    }\n  ]\n}\n"
    SummarizedMetricData:
      description: 'The recorded metric value at a specific timestamp.

        '
      properties:
        aggregatedValue:
          description: 'The aggregated metric value for the specified request.

            '
          example: 1.23
          format: float
          type: number
        aggregationMethod:
          description: 'The aggregation method used for aggregating the metric values.  The aggregation method depends on the metric itself.

            '
          example: count, sum, min, max, and avg
          type: string
        dimensions:
          additionalProperties:
            $ref: '#/components/schemas/DimensionValue'
          description: 'Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace.

            '
          type: object
        resolution:
          description: 'The duration over which the metric data is aggregated. Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.

            '
          example: 5m
          type: string
        sampleTime:
          description: 'The time at which the metric data was recorded.

            '
          format: date-time
          type: string
      type: object
      x-example: "{\n  \"sampleTime\": \"2023-04-08T00:00:00.000Z\",\n  \"resolution\": 1d,\n  \"dimensions\": {\n    \"service_type\": {\n      \"dimensionValue\": \"Std Intel\"\n    },\n    \"pool_name\": {\n      \"dimensionValue\": \"compute_standard\"\n    }\n  },\n  \"aggregationMethod\": \"Sum\",\n  \"aggregatedValue\": 2758\n}\n"
    NamespaceSummary:
      description: 'A summary of the source service or application emitting the metric.

        '
      properties:
        namespaceName:
          description: 'The name of the source service emitting the metric.

            '
          type: string
      required:
      - namespaceName
      type: object
      x-example: "{\n  \"namespaceName\": \"Block Storage\"\n}\n"
    RequestSummarizedMetricDataDetails:
      description: 'The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.

        '
      properties:
        compartmentId:
          description: 'The OCID of the compartment to use for authorization to read metrics. To use the root compartment, provide the tenancyId.

            '
          maxLength: 255
          minLength: 1
          type: string
        dimensions:
          additionalProperties:
            $ref: '#/components/schemas/DimensionValue'
          description: 'Qualifiers to use when searching for metric data. For a list of valid dimensions for a given metric, see [List Metric Properties API](#/en/occ/20230515/MetricPropertyCollection/ListMetricProperties).

            '
          type: object
          x-default-description: 'If no dimension is provided, aggregated metric data from all the associated dimensions, if any, are returned.

            '
        endTime:
          description: 'The end of the sampled time range to use when searching for metric data points. Format is defined by <a href="https://www.rfc-editor.org/rfc/rfc3339">RFC3339</a>. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z

            '
          format: date-time
          type: string
          x-default-description: the timestamp representing when the request was sent.
        metricName:
          description: 'The name of a metric for retrieving aggregated data. For a list of valid metrics for a given namespace, see [List Metric Properties API](#/en/occ/20230515/MetricPropertyCollection/ListMetricProperties).

            '
          maxLength: 255
          minLength: 1
          type: string
        namespaceName:
          description: 'The source service or application to use when searching for metric data points to aggregate. For a list of valid namespaces, see [List Namespaces API](#/en/occ/20230515/NamespaceCollection/ListNamespaces).

            '
          maxLength: 255
          minLength: 1
          type: string
        startTime:
          description: 'The beginning of the sampled time range to use when searching for metric data points. Format is defined by <a href="https://www.rfc-editor.org/rfc/rfc3339">RFC3339</a>. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z

            '
          format: date-time
          type: string
          x-default-description: the timestamp 30 days before the request was sent.
      required:
      - namespaceName
      - metricName
      - compartmentId
      type: object
      x-example: "{\n  \"metricName\": \"AVAILABLE_CORES\",\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleId\",\n  \"namespaceName\": \"Compute\",\n  \"dimensions\": {\n    \"service_type\": {\n      \"dimensionValue\": \"Std Intel\"\n    }\n  }\n}\n  \n"
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    SummarizedMetricDataCollection:
      description: 'A list of aggregated metric data objects with properties.

        '
      properties:
        items:
          description: 'An array of SummarizedMetricData items.

            '
          items:
            $ref: '#/components/schemas/SummarizedMetricData'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"sampleTime\": \"2023-04-08T00:00:00.000Z\",\n      \"resolution\": 1d,\n      \"dimensions\": {\n        \"tenancy_name\": {\n          \"dimensionValue\": \"exampleTenancyName1\"\n        },\n        \"tenancy_ocid\": {\n          \"dimensionValue\": \"ocid1.tenancy.oc1..exampleTenancyOcid1\"\n        }\n      },\n      \"aggregationMethod\": \"Sum\",\n      \"aggregatedValue\": 7\n    },\n    {\n      \"sampleTime\": \"2023-04-08T00:00:00.000Z\",\n      \"resolution\": 1d,\n      \"dimensions\": {\n        \"tenancy_name\": {\n          \"dimensionValue\": \"exampleTenancyName2\"\n        },\n        \"tenancy_ocid\": {\n          \"dimensionValue\": \"ocid1.tenancy.oc1..exampleTenancyOcid2\"\n        }\n      },\n      \"aggregationMethod\": \"Sum\",\n      \"aggregatedValue\": 1\n    }\n  ]\n}\n"
    MetricPropertySummary:
      description: 'A summary of the properties that define a metric.

        '
      properties:
        dimensions:
          additionalProperties:
            $ref: '#/components/schemas/DimensionValue'
          description: 'Qualifiers provided in a metric definition. Available dimensions vary by metric namespace.

            '
          type: object
        metricName:
          description: 'The name of the metric.

            '
          type: string
      required:
      - metricName
      type: object
      x-example: "{\n  \"metricName\": \"AVAILABLE_CORES\",\n  \"dimensions\": {\n    \"service_type\": {\n      \"dimensionValue\": \"Dense Intel\"\n    },\n    \"pool_name\": {\n      \"dimensionValue\": \"broken_pool\"\n    }\n  }\n}\n"
    MetricPropertyCollection:
      description: 'A list of available metrics and their associated properties such as dimensions.

        '
      properties:
        items:
          description: 'An array of MetricPropertySummary objects.

            '
          items:
            $ref: '#/components/schemas/MetricPropertySummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"metricName\": \"AVAILABLE_CORES\",\n      \"dimensions\": {\n        \"service_type\": {\n          \"dimensionValue\": \"Dense Intel\"\n        },\n        \"pool_name\": {\n          \"dimensionValue\": \"broken_pool\"\n        }\n      }\n    },\n    {\n      \"metricName\": \"AVAILABLE_CORES\",\n      \"dimensions\": {\n        \"service_type\": {\n          \"dimensionValue\": \"Dense Intel\"\n        },\n        \"pool_name\": {\n          \"dimensionValue\": \"compute_standard\"\n        }\n      }\n    }\n  ]\n}\n"
    DimensionValue:
      description: 'The dimension value for the given dimension name as key.

        '
      properties:
        dimensionValue:
          description: 'The value of the dimension.

            '
          type: string
      type: object
  parameters:
    Page:
      description: '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>.

        '
      in: query
      name: page
      required: false
      x-default-description: If page is not provided, data from the first page is returned.
      schema:
        type: string
    Limit:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

        '
      in: query
      name: limit
      required: false
      schema:
        type: integer
        default: 750
    NamespaceName:
      description: 'The name of the source service emitting the metric.

        '
      in: path
      name: namespaceName
      required: true
      schema:
        type: string
    RequestIdHeader:
      description: Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.
      in: header
      name: opc-request-id
      schema:
        type: string
    CompartmentId:
      description: 'The OCID of the compartment to use for authorization. To use the root compartment, provide the tenancyId.

        '
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this

        header appears in the response, then a partial list might have been

        returned. Include this value as the `page` parameter for the subsequent

        GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
  x-properties:
    x-tag-groups:
      occMetricData:
      - occMetrics
      occServiceData:
      - occMetrics
x-obmcs-client-circuit-breaker-enabled: true
x-obmcs-client-retries-enabled: true
x-obmcs-use-shared-work-requests-service: false
x-oracle-package: com.oracle.oci.occ