openapi: 3.2.0
info:
  description: "Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n"
  title: OS Management Hub Reporting Managed Instance API
  version: '20220901'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OS Management Hub 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/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    what: the harvested document for OS Management Hub API
servers:
- url: http://127.0.0.1/20220901
- url: https://127.0.0.1/20220901
tags:
- name: reportingManagedInstance
paths:
  /managedInstanceAnalytics:
    get:
      description: 'Returns a list of user specified metrics for a collection of managed instances.

        '
      operationId: SummarizeManagedInstanceAnalytics
      parameters:
      - $ref: '#/components/parameters/MultiMetricNameQueryParam'
      - $ref: '#/components/parameters/ReportCompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceGroupIdQueryParam'
      - $ref: '#/components/parameters/DynamicSetIdQueryParam'
      - $ref: '#/components/parameters/LifecycleEnvironmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStageIdQueryParam'
      - $ref: '#/components/parameters/MultiManagedInstanceStatusQueryParam'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/MultiOsFamilyQueryParam'
      - $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam'
      - $ref: '#/components/parameters/MultiDisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/ReportingSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'A list of metrics for a collection of managed instances matching the given filters was retrieved.

            '
          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/ManagedInstanceAnalyticCollection'
        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: Returns user specified metrics for a collection of managed instances which match the given filters.
      tags:
      - reportingManagedInstance
      x-example: 'GET 20220901/managedInstanceAnalytics?compartmentId=<var>&lt;compartment_OCID&gt;</var>&metricNames=<var>&lt;metric_name&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/ManagedInstanceAnalyticCollection'
  /managedInstanceAnalytics/content:
    get:
      description: 'Returns a report of managed instances matching the given filters. You can select CSV, XML, or JSON format.

        '
      operationId: GetManagedInstanceAnalyticContent
      parameters:
      - $ref: '#/components/parameters/ReportCompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceGroupIdQueryParam'
      - $ref: '#/components/parameters/DynamicSetIdQueryParam'
      - $ref: '#/components/parameters/LifecycleEnvironmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStageIdQueryParam'
      - $ref: '#/components/parameters/MultiManagedInstanceStatusQueryParam'
      - $ref: '#/components/parameters/MultiDisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/SecurityUpdatesAvailableEqualsTo'
      - $ref: '#/components/parameters/BugUpdatesAvailableEqualsTo'
      - $ref: '#/components/parameters/OtherUpdatesAvailableEqualsTo'
      - $ref: '#/components/parameters/SecurityUpdatesAvailableGreaterThan'
      - $ref: '#/components/parameters/BugUpdatesAvailableGreaterThan'
      - $ref: '#/components/parameters/OtherUpdatesAvailableGreaterThan'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/MultiOsFamilyQueryParam'
      - $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam'
      - $ref: '#/components/parameters/ReportFormatParam'
      - $ref: '#/components/parameters/ReportTypeParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The user selected format (CSV/XML/JSON) report was downloaded.
          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/x-yaml:
              schema:
                format: binary
                type: string
        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: Download report in user selected format (CSV/XML/JSON) of a collection of managed instances
      tags:
      - reportingManagedInstance
      x-example: 'GET 20220901/managedInstanceAnalytics/content?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/ManagedInstance'
  /managedInstances/{managedInstanceId}/content:
    get:
      description: 'Returns a report for a single managed instance whose associated erratas match the given filters. You can select CSV, XML, or JSON format.

        '
      operationId: GetManagedInstanceContent
      parameters:
      - $ref: '#/components/parameters/ManagedInstanceIdPathParam'
      - $ref: '#/components/parameters/AdvisoryNameQueryParam'
      - $ref: '#/components/parameters/AdvisoryNameContainsQueryParam'
      - $ref: '#/components/parameters/MultiAdvisoryTypeQueryParam'
      - $ref: '#/components/parameters/MultiVulnerabilityNameQueryParam'
      - $ref: '#/components/parameters/VulnerabilityNameContainsQueryParam'
      - $ref: '#/components/parameters/MultiVulnerabilityTypeQueryParam'
      - $ref: '#/components/parameters/ReportFormatParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The user selected format (CSV/XML/JSON) report was downloaded.
          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/x-yaml:
              schema:
                format: binary
                type: string
        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: Download a user selected format (CSV/XML/JSON) vulnerability report of a single managed instances
      tags:
      - reportingManagedInstance
      x-example: 'GET 20220901/managedInstances/<var>&lt;resource_OCID&gt;</var>/content

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/ManagedInstance'
components:
  parameters:
    SecurityUpdatesAvailableEqualsTo:
      description: A filter to return instances that have the specified number of available security updates.
      in: query
      name: securityUpdatesAvailableEqualsTo
      required: false
      x-default-description: 'null'
      schema:
        type: integer
    OtherUpdatesAvailableGreaterThan:
      description: A filter to return instances that have more available other updates than the number specified.
      in: query
      name: otherUpdatesAvailableGreaterThan
      required: false
      x-default-description: 'null'
      schema:
        type: integer
    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).


        Example: `3`

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    AdvisoryNameContainsQueryParam:
      description: A filter to return resources that may partially match the erratum advisory name given.
      in: query
      name: advisoryNameContains
      required: false
      x-default-description: 'null'
      schema:
        type: string
    AdvisoryNameQueryParam:
      description: 'The assigned erratum name. It''s unique and not changeable.


        Example: `ELSA-2020-5804`

        '
      in: query
      name: advisoryName
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
        maxItems: 51
    DynamicSetIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set.
      in: query
      name: dynamicSetId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    MultiVulnerabilityNameQueryParam:
      description: A filter to return vulnerabilities that match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name.
      in: query
      name: vulnerabilityName
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
        uniqueItems: true
    MultiDisplayNameQueryParam:
      description: A filter to return resources that match the given display names.
      in: query
      name: displayName
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          maxLength: 255
          minLength: 1
          type: string
        maxItems: 5
        uniqueItems: true
    DisplayNameContainsQueryParam:
      description: A filter to return resources that may partially match the given display name.
      in: query
      name: displayNameContains
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ReportCompartmentIdQueryParam:
      description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. \nThis filter returns only resources contained within the specified compartment.\n"
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
    ManagedInstanceGroupIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group.
      in: query
      name: managedInstanceGroupId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    BugUpdatesAvailableGreaterThan:
      description: A filter to return instances that have more available bug updates than the number specified.
      in: query
      name: bugUpdatesAvailableGreaterThan
      required: false
      x-default-description: 'null'
      schema:
        type: integer
    MultiLocationQueryParam:
      description: A filter to return only resources whose location matches the given value.
      in: query
      name: location
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        maxItems: 5
        uniqueItems: true
    ReportingSortByQueryParam:
      description: "The field to sort by. Only one sort order may be provided. The default is to sort in ascending order by metricName (previously name, which is now depricated). \nYou can also sort by displayName (default is ascending order).\n"
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - name
        - metricName
        - displayName
        default: name
    ReportFormatParam:
      description: The format of the report to download. Default is CSV.
      in: query
      name: reportFormat
      schema:
        type: string
        enum:
        - csv
        - json
        - xml
        default: csv
    MultiOsFamilyQueryParam:
      description: A filter to return only resources that match the given operating system family.
      in: query
      name: osFamily
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        maxItems: 5
        uniqueItems: true
    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).


        Example: `50`

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    LifecycleStageIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. This resource returns resources associated with this lifecycle stage.
      in: query
      name: lifecycleStageId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'ASC' or '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
    CompartmentIdInSubTreeQueryParam:
      description: Indicates whether to include subcompartments in the returned results. Default is false.
      in: query
      name: compartmentIdInSubtree
      required: false
      x-default-description: false
      schema:
        type: boolean
    MultiVulnerabilityTypeQueryParam:
      description: A filter to return only vulnerabilities matching the given types.
      in: query
      name: vulnerabilityType
      required: true
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          - OTHER
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VulnerabilityTypes'
        uniqueItems: true
    SecurityUpdatesAvailableGreaterThan:
      description: A filter to return instances that have more available security updates than the number specified.
      in: query
      name: securityUpdatesAvailableGreaterThan
      required: false
      x-default-description: 'null'
      schema:
        type: integer
    BugUpdatesAvailableEqualsTo:
      description: A filter to return instances that have the specified number of available bug updates.
      in: query
      name: bugUpdatesAvailableEqualsTo
      required: false
      x-default-description: 'null'
      schema:
        type: integer
    MultiManagedInstanceStatusQueryParam:
      description: A filter to return only managed instances whose status matches the status provided.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - NORMAL
          - UNREACHABLE
          - ERROR
          - WARNING
          - REGISTRATION_ERROR
          - DELETING
          - ONBOARDING
          - REBOOTING
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceStatus'
        maxItems: 5
        uniqueItems: true
    ReportTypeParam:
      description: The type of the report the user wants to download. Default is ALL.
      in: query
      name: reportType
      schema:
        type: string
        enum:
        - SECURITY
        - BUGFIX
        - ACTIVITY
        - OTHER
        - ALL
        default: ALL
    MultiLocationNotEqualToQueryParam:
      description: A filter to return only resources whose location does not match the given value.
      in: query
      name: locationNotEqualTo
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        maxItems: 5
        uniqueItems: true
    MultiMetricNameQueryParam:
      description: A filter to return only metrics whose name matches the given metric names.
      in: query
      name: metricNames
      required: true
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - TOTAL_INSTANCE_COUNT
          - INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT
          - INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT
          - NORMAL_INSTANCE_COUNT
          - ERROR_INSTANCE_COUNT
          - WARNING_INSTANCE_COUNT
          - UNREACHABLE_INSTANCE_COUNT
          - REGISTRATION_FAILED_INSTANCE_COUNT
          - INSTANCE_WITH_AVAILABLE_OTHER_UPDATES_COUNT
          - DELETING_INSTANCE_COUNT
          - ONBOARDING_INSTANCE_COUNT
          - INSTANCE_SECURITY_UPDATES_COUNT
          - INSTANCE_BUGFIX_UPDATES_COUNT
          - INSTANCE_SECURITY_ADVISORY_COUNT
          - INSTANCE_BUGFIX_ADVISORY_COUNT
          - INSTANCE_OTHER_UPDATES_COUNT
          - REBOOTING_INSTANCE_COUNT
          - NEEDS_REBOOTING_INSTANCE_COUNT
          type: string
          x-obmcs-top-level-enum: '#/definitions/MetricName'
        uniqueItems: true
    IsManagedByAutonomousLinuxQueryParam:
      description: 'Indicates whether to list only resources managed by the Autonomous Linux service.

        '
      in: query
      name: isManagedByAutonomousLinux
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
    OtherUpdatesAvailableEqualsTo:
      description: A filter to return instances that have the specified number of available other updates.
      in: query
      name: otherUpdatesAvailableEqualsTo
      required: false
      x-default-description: 'null'
      schema:
        type: integer
    ManagedInstanceIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance.
      in: path
      name: managedInstanceId
      required: true
      schema:
        type: string
    LifecycleEnvironmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment.
      in: query
      name: lifecycleEnvironmentId
      required: false
      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.
      in: header
      name: opc-request-id
      schema:
        type: string
    MultiAdvisoryTypeQueryParam:
      description: A filter to return only errata that match the given advisory types.
      in: query
      name: advisoryType
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - SECURITY
          - BUGFIX
          - ENHANCEMENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/AdvisoryTypes'
        maxItems: 5
        uniqueItems: true
    VulnerabilityNameContainsQueryParam:
      description: A filter to return vulnerabilities that partially match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name.
      in: query
      name: vulnerabilityNameContains
      x-default-description: 'null'
      schema:
        type: string
  schemas:
    Error:
      description: Provides the information for an error.
      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
    ManagedInstanceAnalyticSummary:
      description: A metric emitted by managed instance resource.
      properties:
        count:
          description: The value of this metric.
          type: integer
        dimensions:
          additionalProperties:
            maxLength: 255
            minLength: 1
            type: string
          description: 'Qualifiers provided in a metric definition. Available dimensions vary by metric namespace.

            Each dimension takes the form of a key-value pair.


            Example: `"managedInstanceId": "ocid1.managementagent.123"`

            '
          type: object
        name:
          description: The name of this metric.
          enum:
          - TOTAL_INSTANCE_COUNT
          - INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT
          - INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT
          - NORMAL_INSTANCE_COUNT
          - ERROR_INSTANCE_COUNT
          - WARNING_INSTANCE_COUNT
          - UNREACHABLE_INSTANCE_COUNT
          - REGISTRATION_FAILED_INSTANCE_COUNT
          - INSTANCE_WITH_AVAILABLE_OTHER_UPDATES_COUNT
          - DELETING_INSTANCE_COUNT
          - ONBOARDING_INSTANCE_COUNT
          - INSTANCE_SECURITY_UPDATES_COUNT
          - INSTANCE_BUGFIX_UPDATES_COUNT
          - INSTANCE_SECURITY_ADVISORY_COUNT
          - INSTANCE_BUGFIX_ADVISORY_COUNT
          - INSTANCE_OTHER_UPDATES_COUNT
          - REBOOTING_INSTANCE_COUNT
          - NEEDS_REBOOTING_INSTANCE_COUNT
          type: string
          x-obmcs-top-level-enum: '#/definitions/MetricName'
      required:
      - name
      - dimensions
      - count
      type: object
    ManagedInstanceAnalyticCollection:
      description: A set of managed instance metrics returned for the [SummarizeManagedInstanceAnalytics](#/en/osmh/latest/ManagedInstanceAnalyticCollection/SummarizeManagedInstanceAnalytics) operation.
      properties:
        items:
          description: List of managed instance analytic summary objects.
          items:
            $ref: '#/components/schemas/ManagedInstanceAnalyticSummary'
          type: array
      required:
      - items
      type: object
  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-total-items:
      description: 'The total number of items in the result. Used for pagination of a list of items.

        '
      type: integer
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

        '
      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 string type is supported.

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

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

          '
        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.oci.osmh.api