openapi: 3.2.0
info:
  description: 'Use the Resource Discovery and Monitoring Control API to get details about monitored instances and perform actions. For more information, see [Resource Discovery and Monitoring](https://docs.oracle.com/iaas/os-management/osms/osms-resource-discovery-monitoring.htm).

    '
  title: Resource Discovery and Monitoring Control Appmgmt Control API
  version: '20210330'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/1519a9c9fba0216ecb3013b91956f5f5cc7aca110c96f3192f7ea8de0e7013e2.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Resource Discovery and Monitoring Control 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/1519a9c9fba0216ecb3013b91956f5f5cc7aca110c96f3192f7ea8de0e7013e2.yaml
    what: the harvested document for Resource Discovery and Monitoring Control API
servers:
- url: http://127.0.0.1/20210330
- url: https://127.0.0.1/20210330
tags:
- name: appmgmtControl
paths:
  /monitoredInstances:
    get:
      description: 'Returns a list of monitored instances.

        '
      operationId: ListMonitoredInstances
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortMonitoredInstancesByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of MonitoredInstanceSummary objects.
          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/MonitoredInstanceCollection'
        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 all monitored instances in a given compartment
      tags:
      - appmgmtControl
      x-example: 'GET /20210330/monitoredInstances?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/MonitoredInstanceCollection'
  /monitoredInstances/{monitoredInstanceId}:
    get:
      description: Gets a monitored instance by identifier
      operationId: GetMonitoredInstance
      parameters:
      - $ref: '#/components/parameters/MonitoredInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the monitored instance with the given id
          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/MonitoredInstance'
        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 monitored instance details
      tags:
      - appmgmtControl
      x-example: 'GET /20210330/monitoredInstances/<var>&lt;monitored_instance_OCID&gt;</var>

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
  /monitoredInstances/{monitoredInstanceId}/actions/activateMonitoringPlugin:
    post:
      description: 'Activates Resource Plugin for compute instance identified by the instance ocid.

        Stores monitored instances Id and its state. Tries to enable Resource Monitoring plugin by making

        remote calls to Oracle Cloud Agent and Management Agent Cloud Service.

        '
      operationId: ActivateMonitoringPlugin
      parameters:
      - $ref: '#/components/parameters/MonitoredInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. Resource Monitoring plugin will be activated on monitored instance.
          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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Activates Resource Plugin for compute instance identified by the instance ocid.
      tags:
      - appmgmtControl
      x-example: 'POST /20210330/monitoredInstances/<var>&lt;monitored_instance_OCID&gt;</var>/actions/activateMonitoringPlugin

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/MonitoredInstance'
  /monitoredInstances/{monitoredInstanceId}/actions/publishTopProcessesMetrics:
    post:
      description: 'Starts cpu and memory top processes collection.

        '
      operationId: PublishTopProcessesMetrics
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/MonitoredInstanceIdentifierPathParam'
      responses:
        202:
          description: Request accepted. Collection of top process has started.
          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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        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'
      summary: Starts data collection.
      tags:
      - appmgmtControl
      x-example: 'POST /20210330/monitoredInstances/<var>&lt;monitored_instance_OCID&gt;</var>/actions/publishTopProcessesMetrics

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/MonitoredInstance'
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          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/WorkRequestSummaryCollection'
        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 Work Requests
      tags:
      - appmgmtControl
      x-example: 'GET /20210330/workRequests?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The detail of the work request.
          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
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        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 Work Request Status
      tags:
      - appmgmtControl
      x-example: 'GET /20210330/workRequests/<var>&lt;appmgmt_work_request_OCID&gt;</var>

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Return a (paginated) list of errors for a given work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request errors.
          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/WorkRequestErrorCollection'
        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: Lists work request errors
      tags:
      - appmgmtControl
      x-example: 'GET /20210330/workRequests/<var>&lt;appmgmt_work_request_OCID&gt;</var>/errors

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Return a (paginated) list of logs for a given work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request logs.
          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/WorkRequestLogEntryCollection'
        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: Lists work request logs
      tags:
      - appmgmtControl
      x-example: 'GET /20210330/workRequests/<var>&lt;appmgmt_work_request_OCID&gt;</var>/logs

        Host: cp.appmgmt.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  parameters:
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    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
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 20
        minimum: 1
    SortOrderQueryParam:
      description: The sort order to use, either ascending ('ASC') or descending ('DESC').
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    WorkRequestIdPathParam:
      description: The ID of the asynchronous request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    WorkRequestIdQueryParam:
      description: The ID of the asynchronous work request.
      in: query
      name: workRequestId
      x-default-description: 'null'
      schema:
        type: string
    MonitoredInstanceIdentifierPathParam:
      description: OCID of monitored instance.
      in: path
      name: monitoredInstanceId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 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 executing 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 purged 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
    SortMonitoredInstancesByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
  schemas:
    MonitoredInstanceSummary:
      description: Summary of the monitored instance.
      properties:
        compartmentId:
          description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm)
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name of the monitored instance. It is binded to [Compute Instance](/Content/Compute/Concepts/computeoverview.htm).

            DisplayName is fetched from [Core Service API](/api/#/en/iaas/20160918/Instance/).

            '
          maxLength: 255
          minLength: 1
          type: string
        instanceId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of monitored instance.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the monitored instance.
          type: string
          x-obmcs-enumref: '#/definitions/MonitoredInstance/lifecycleState'
        managementAgentId:
          description: Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).
          maxLength: 255
          minLength: 1
          type: string
        monitoringState:
          description: Monitoring status. Can be either enabled or disabled.
          type: string
          x-obmcs-enumref: '#/definitions/MonitoredInstance/monitoringState'
      required:
      - instanceId
      - compartmentId
      type: object
      x-example: "{\n  \"instanceId\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n  \"compartmentId\": \"ocid1.comapertment.oc1..&lt;unique_id&gt;\",\n  \"displayName\": \"someDisplayName\",\n  \"managementAgentId\": \"ocid1.managementagent.oc1.iad.&lt;unique_id&gt;\",\n  \"monitoringState\": \"ENABLED\",\n  \"lifecycleState\": \"ACTIVE\"\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
    WorkRequestSummaryCollection:
      description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestSummary objects.
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  items: [\n    {\n      \"operationType\": \"ACTIVATE_RESOURCE_MONITORING_PLUGIN\",\n      \"status\": \"SUCCEEDED\",\n      \"id\": \"ocid1.appmgmtworkrequest.oc1.iad.&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.comapertment.oc1..&lt;unique_id&gt;\",\n      \"resources\": [\n        {\n          \"entityType\": \"monitoredInstance\",\n          \"actionType\": \"CREATED\"\n          \"identifier\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n          \"entityUri\": \"/monitoredInstances/ocid1.instance.oc1.iad.&lt;unique_id&gt;\"\n        }\n      ],\n      \"percentComplete\": 100,\n      \"timeAccepted\": \"2021-11-29T19:11:37.920+0100\",\n      \"timeStarted\": \"2021-11-29T19:11:55.920+0100\",\n      \"timeFinished\": \"2021-11-29T19:13:37.920+0100\"\n    }\n  ]\n}\n"
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the work tracked in the work request.

            A resource being created, updated, or deleted will remain in the IN_PROGRESS state until

            work is complete for that resource at which point it will transition to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - RELATED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: The resource type the work request affects.
          type: string
        entityUri:
          description: The URI path that the user can do a GET on to access the resource metadata
          type: string
        identifier:
          description: The identifier of the resource the work request affects.
          type: string
      required:
      - actionType
      - entityType
      - identifier
      x-example: "{\n  \"entityType\": \"monitoredInstance\",\n  \"actionType\": \"CREATED\"\n  \"identifier\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n  \"entityUri\": \"/monitoredInstances/ocid1.instance.oc1.iad.&lt;unique_id&gt;\"\n}\n"
    MonitoredInstance:
      description: Description of Monitored Instance.
      properties:
        compartmentId:
          description: Compartment Identifier [OCID](/Content/General/Concepts/identifiers.htm)
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name of the monitored instance. It is binded to [Compute Instance](/Content/Compute/Concepts/computeoverview.htm).

            DisplayName is fetched from [Core Service API](/api/#/en/iaas/20160918/Instance/).

            '
          maxLength: 255
          minLength: 1
          type: string
        instanceId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of monitored instance.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
          type: string
        lifecycleState:
          description: The current state of the monitored instance.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        managementAgentId:
          description: 'Management Agent Identifier [OCID](/Content/General/Concepts/identifiers.htm).

            Used to invoke manage operations on Management Agent Cloud Service.

            '
          maxLength: 255
          minLength: 1
          type: string
        monitoringState:
          default: DISABLED
          description: Monitoring status. Can be either enabled or disabled.
          enum:
          - ENABLED
          - DISABLED
          type: string
        timeCreated:
          description: The time the MonitoredInstance was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the MonitoredInstance was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - instanceId
      - compartmentId
      type: object
      x-example: "{\n  \"instanceId\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n  \"compartmentId\": \"ocid1.comapertment.oc1..&lt;unique_id&gt;\",\n  \"displayName\": \"someDisplayName\",\n  \"managementAgentId\": \"ocid1.managementagent.oc1.iad.&lt;unique_id&gt;\",\n  \"timeCreated\": \"2021-10-27T17:05:50.347+0200\",\n  \"timeUpdated\": \"2021-11-29T13:22:57.729+0100\",\n  \"monitoringState\": \"ENABLED\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails: \"\"\n}\n"
    WorkRequestErrorCollection:
      description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestError objects.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  items: [\n    {\n      \"code\": \"500\",\n      \"message\": \"Get MACS agent id retry count exceeded limit. There is an issue with MACS plugin deployment\",\n      \"timestamp: \"2021-11-29T19:11:55.920+0100\"\n    }\n  ]\n}\n"
    WorkRequestSummary:
      description: A summary of the status of a work request.
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: Type of the work request
          enum:
          - ACTIVATE_RESOURCE_MONITORING_PLUGIN
          - PUBLISH_TOP_PROCESSES_METRICS
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: Status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
      x-example: "{\n  \"operationType\": \"ACTIVATE_RESOURCE_MONITORING_PLUGIN\",\n  \"status\": \"SUCCEEDED\",\n  \"id\": \"ocid1.appmgmtworkrequest.oc1.iad.&lt;unique_id&gt;\",\n  \"compartmentId\": \"ocid1.comapertment.oc1..&lt;unique_id&gt;\",\n  \"resources\": [\n    {\n      \"entityType\": \"monitoredInstance\",\n      \"actionType\": \"CREATED\"\n      \"identifier\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n      \"entityUri\": \"/monitoredInstances/ocid1.instance.oc1.iad.&lt;unique_id&gt;\"\n    }\n  ],\n  \"percentComplete\": 100,\n  \"timeAccepted\": \"2021-11-29T19:11:37.920+0100\",\n  \"timeStarted\": \"2021-11-29T19:11:55.920+0100\",\n  \"timeFinished\": \"2021-11-29T19:13:37.920+0100\"\n}\n"
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

            '
          type: string
        message:
          description: A human readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
      x-example: "{\n  \"code\": \"500\",\n  \"message\": \"Get MACS agent id retry count exceeded limit. There is an issue with MACS plugin deployment\",\n  \"timestamp: \"2021-11-29T19:11:55.920+0100\"\n}\n"
    MonitoredInstanceCollection:
      description: Results of a monitored instance search. Contains MonitoredInstanceSummary items.
      properties:
        items:
          description: List of monitored instances.
          items:
            $ref: '#/components/schemas/MonitoredInstanceSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  items: [\n    {\n      \"instanceId\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.comapertment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"someDisplayName\",\n      \"managementAgentId\": \"ocid1.managementagent.oc1.iad.&lt;unique_id&gt;\",\n      \"monitoringState\": \"ENABLED\",\n      \"lifecycleState\": \"ACTIVE\"\n    }\n  ]\n}\n"
    WorkRequestLogEntry:
      description: A log message from the execution of a work request.
      properties:
        message:
          description: Human-readable log message.
          type: string
        timestamp:
          description: The time the log message was written. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - message
      - timestamp
      x-example: "{\n  \"message\": \"Management Agent OCA plugin has been deployed to Monitored Instance\",\n  \"timestamp: \"2021-11-29T19:11:55.920+0100\"\n}\n"
    WorkRequestLogEntryCollection:
      description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
      properties:
        items:
          description: List of workRequestLogEntries.
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  items: [\n    {\n      \"message\": \"Management Agent OCA plugin has been deployed to Monitored Instance\",\n      \"timestamp: \"2021-11-29T19:11:55.920+0100\"\n    },\n    {\n      \"message\": \"Successfully activated Resource Monitoring Plugin\",\n      \"timestamp: \"2021-11-29T19:13:55.920+0100\"\n    }\n  ]\n}\n"
    WorkRequest:
      description: A description of workrequest status
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: Type of the work request
          enum:
          - ACTIVATE_RESOURCE_MONITORING_PLUGIN
          - PUBLISH_TOP_PROCESSES_METRICS
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: Status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
      x-example: "{\n  \"operationType\": \"ACTIVATE_RESOURCE_MONITORING_PLUGIN\",\n  \"status\": \"SUCCEEDED\",\n  \"id\": \"ocid1.appmgmtworkrequest.oc1.iad.&lt;unique_id&gt;\",\n  \"compartmentId\": \"ocid1.comapertment.oc1..&lt;unique_id&gt;\",\n  \"resources\": [\n    {\n      \"entityType\": \"monitoredInstance\",\n      \"actionType\": \"CREATED\"\n      \"identifier\": \"ocid1.instance.oc1.iad.&lt;unique_id&gt;\",\n      \"entityUri\": \"/monitoredInstances/ocid1.instance.oc1.iad.&lt;unique_id&gt;\"\n    }\n  ],\n  \"percentComplete\": 100,\n  \"timeAccepted\": \"2021-11-29T19:11:37.920+0100\",\n  \"timeStarted\": \"2021-11-29T19:11:55.920+0100\",\n  \"timeFinished\": \"2021-11-29T19:13:37.920+0100\"\n}\n"
  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
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      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 string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

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

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

        '
      type: object
x-oracle-package: com.oracle.pic.appmgmt.cp