Oracle Monitored Region API

openapi: 3.2.0
info:
  description: Use the Resource Analytics API to manage Resource Analytics Instances.
  title: Resource Analytics Monitored Region API
  version: '20241031'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/1a82316aad68b9af959107b385c7c1d37b7637331f595fc0ad2be484a0b6c735.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Resource Analytics 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/1a82316aad68b9af959107b385c7c1d37b7637331f595fc0ad2be484a0b6c735.yaml
    what: the harvested document for Resource Analytics API
servers:
- url: http://127.0.0.1/20241031
- url: https://127.0.0.1/20241031
tags:
- name: monitoredRegion
paths:
  /monitoredRegions:
    get:
      description: 'Gets a list of MonitoredRegions.

        '
      operationId: ListMonitoredRegions
      parameters:
      - $ref: '#/components/parameters/ResourceAnalyticsInstanceIdQueryParam'
      - $ref: '#/components/parameters/MonitoredRegionLifecycleStateQueryParam'
      - $ref: '#/components/parameters/MonitoredRegionIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/MonitoredRegionSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of MonitoredRegionSummary objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              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/MonitoredRegionCollection'
        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: Gets a list of MonitoredRegions.
      tags:
      - monitoredRegion
      x-obmcs-cli-action: list
      x-related-resource: '#/definitions/MonitoredRegionCollection'
    post:
      description: 'Creates a MonitoredRegion.

        '
      operationId: CreateMonitoredRegion
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The MonitoredRegion will be created.
          headers:
            content-location:
              description: Same as location.
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URL for the created MonitoredRegion. The MonitoredRegion OCID is generated after this request is sent.
              schema:
                type: string
                format: uri-reference
            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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoredRegion'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a MonitoredRegion.
      tags:
      - monitoredRegion
      x-obmcs-cli-action: create
      x-related-resource: '#/definitions/MonitoredRegion'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMonitoredRegionDetails'
        description: Details for the new MonitoredRegion.
        required: true
  /monitoredRegions/{monitoredRegionId}:
    delete:
      description: Deletes a MonitoredRegion.
      operationId: DeleteMonitoredRegion
      parameters:
      - $ref: '#/components/parameters/MonitoredRegionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The MonitoredRegion will be deleted.
          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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a MonitoredRegion.
      tags:
      - monitoredRegion
      x-obmcs-cli-action: delete
      x-related-resource: '#/definitions/MonitoredRegion'
    get:
      description: Gets information about a MonitoredRegion.
      operationId: GetMonitoredRegion
      parameters:
      - $ref: '#/components/parameters/MonitoredRegionIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The MonitoredRegion was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/MonitoredRegion'
        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: Get MonitoredRegion
      tags:
      - monitoredRegion
      x-obmcs-cli-action: get
components:
  schemas:
    MonitoredRegionCollection:
      description: Results of a MonitoredRegion search. Contains both MonitoredRegionSummary items and other information, such as metadata.
      properties:
        items:
          description: List of MonitoredRegions.
          items:
            $ref: '#/components/schemas/MonitoredRegionSummary'
          type: array
      required:
      - items
      type: object
    MonitoredRegionSummary:
      description: Summary information about a MonitoredRegion.
      properties:
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the MonitoredRegion in more detail. For example,

            can be used to provide actionable information for a resource in the Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the MonitoredRegion.
          type: string
          x-obmcs-enumref: '#/definitions/MonitoredRegion/lifecycleState'
        regionId:
          description: The [Region Identifier](/iaas/Content/General/Concepts/regions.htm) of this MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        resourceAnalyticsInstanceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ResourceAnalyticsInstance associated with this MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the MonitoredRegion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the MonitoredRegion was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - resourceAnalyticsInstanceId
      - regionId
      - lifecycleState
      - timeCreated
      type: object
    CreateMonitoredRegionDetails:
      description: The data to create a MonitoredRegion.
      properties:
        regionId:
          description: The [Region Identifier](/iaas/Content/General/Concepts/regions.htm) of this MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        resourceAnalyticsInstanceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ResourceAnalyticsInstance associated with this MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - resourceAnalyticsInstanceId
      - regionId
      type: object
    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 message.
          type: string
      required:
      - code
      - message
    MonitoredRegion:
      description: 'A MonitoredRegion is a region to collect data for the associated ResourceAnalyticsInstance.


        To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to

        an administrator. If you''re an administrator who needs to write policies to give users access, see

        [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

        '
      properties:
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the MonitoredRegion in more detail. For example,

            can be used to provide actionable information for a resource in the Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the MonitoredRegion.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        regionId:
          description: The [Region Identifier](/iaas/Content/General/Concepts/regions.htm) of this MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        resourceAnalyticsInstanceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ResourceAnalyticsInstance associated with this MonitoredRegion.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the MonitoredRegion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the MonitoredRegion was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - resourceAnalyticsInstanceId
      - regionId
      - lifecycleState
      - timeCreated
      type: object
  parameters:
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the

        `if-match` parameter to the value of the etag from a previous GET or POST response for

        that resource. The resource will be updated or deleted only if the etag you provide

        matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    MonitoredRegionIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MonitoredRegion.
      in: path
      name: monitoredRegionId
      required: true
      x-obmcs-cli-param: monitored-region-id
      schema:
        type: string
    MonitoredRegionIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MonitoredRegion.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either ascending (`ASC`) or descending (`DESC`).
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is `DESC` when sorting by time and `ASC` otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    PaginationTokenQueryParam:
      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

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    ResourceAnalyticsInstanceIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a ResourceAnalyticsInstance.
      in: query
      name: resourceAnalyticsInstanceId
      x-default-description: 'null'
      schema:
        type: string
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

        The only valid characters for request IDs are letters, numbers,

        underscore, and dash.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a

        paginated "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of running that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and removed from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    MonitoredRegionLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The

        state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/MonitoredRegion/lifecycleState'
      schema:
        type: string
    MonitoredRegionSortByQueryParam:
      description: 'The field to sort by. You can provide only one sort order. Default order for `TIME_CREATED`

        is descending. Default order for `REGION_ID` is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIME_CREATED
        - REGION_ID
        default: TIME_CREATED
  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 list pagination. When this header appears in the response, additional pages of results remain. For

        important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      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
    opc-work-request-id:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

        Use GetWorkRequest with this ID to track the status of the request.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


          Example: `{"CostCenter": "42"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Department": "Finance"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


          Example: `{"free-tier-retained": "true"}`

          '
        type: object
      description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.pic.galaxy.cp