Oracle Compute Management API

The computeManagement API from Oracle — 23 operation(s) for computemanagement.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-computemanagement-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'Use the Core Services API to manage resources such as virtual cloud networks (VCNs),

    compute instances, and block storage volumes. For more information, see the console

    documentation for the [Networking](/iaas/Content/Network/Concepts/overview.htm),

    [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and

    [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services.

    The required permissions are documented in the

    [Details for the Core Services](/iaas/Content/Identity/Reference/corepolicyreference.htm) article.

    '
  license:
    name: Oracle Corporation
  title: Core Services Compute Management API
  version: '20160918'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Core Services 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/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml
    what: the harvested document for Core Services API
servers:
- url: /20160918
tags:
- name: computeManagement
paths:
  /clusterNetworks:
    get:
      description: 'Lists the [cluster networks with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm)

        in the specified compartment.

        '
      operationId: ListClusterNetworks
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: 'A filter to only return resources that match the given lifecycle

          state. The state value is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/ClusterNetworkSummary/lifecycleState'
        schema:
          type: string
      responses:
        200:
          description: The list 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:
                items:
                  $ref: '#/components/schemas/ClusterNetworkSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListClusterNetworks
      tags:
      - computeManagement
      x-example: "GET /20160918/clusterNetworks\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/ClusterNetwork'
    post:
      description: 'Creates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).

        A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal

        instances that are connected with an ultra low-latency remote direct memory access (RDMA) network.

        Cluster networks with instance pools use instance pools to manage groups of identical instances.


        Use cluster networks with instance pools when you want predictable capacity for a specific number of identical

        instances that are managed as a group.


        If you want to manage instances in the RDMA network independently of each other or use different types of instances

        in the network group, create a compute cluster by using the [CreateComputeCluster](#/en/iaas/latest/ComputeCluster/CreateComputeCluster)

        operation.


        To determine whether capacity is available for a specific shape before you create a cluster network,

        use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport)

        operation.

        '
      operationId: CreateClusterNetwork
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The cluster network.
          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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.

                Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)

                with this ID to track the status of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterNetwork'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: CreateClusterNetwork
      tags:
      - computeManagement
      x-example: "POST /20160918/clusterNetworks\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"hpc-cluster-network\",\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"instancePools\": [\n    {\n      \"displayName\": \"hpc-instance-pool-1\",\n      \"instanceConfigurationId\": \"ocid1.instanceconfiguration.oc1..<var>&lt;unique_ID&gt;</var>\",\n      \"size\": 10,\n    }\n  ],\n  \"placementConfiguration\":\n  {\n    \"availabilityDomain\": \"Uocm:PHX-AD-1\",\n    \"primarySubnetId\": \"ocid1.subnet.oc1..<var>&lt;unique_ID&gt;</var>\"\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterNetworkDetails'
        description: Cluster network creation details
        required: true
  /clusterNetworks/{clusterNetworkId}:
    delete:
      description: 'Deletes (terminates) a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).


        When you delete a cluster network, all of its resources are permanently deleted,

        including associated instances and instance pools.

        '
      operationId: TerminateClusterNetwork
      parameters:
      - $ref: '#/components/parameters/ClusterNetworkIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: The cluster network is being terminated.
          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 work request.

                Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/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'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: TerminateClusterNetwork
      tags:
      - computeManagement
      x-example: '​DELETE /20160918/clusterNetworks/<var>&lt;cluster_network_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/ClusterNetwork'
    get:
      description: 'Gets information about a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).

        '
      operationId: GetClusterNetwork
      parameters:
      - $ref: '#/components/parameters/ClusterNetworkIdPathParam'
      responses:
        200:
          description: The cluster network 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/ClusterNetwork'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetClusterNetwork
      tags:
      - computeManagement
      x-example: 'GET /20160918/clusterNetworks/<var>&lt;cluster_network_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

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

        '
    put:
      description: 'Updates a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).

        The OCID of the cluster network remains the same.

        '
      operationId: UpdateClusterNetwork
      parameters:
      - $ref: '#/components/parameters/ClusterNetworkIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The cluster network was updated.
          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/ClusterNetwork'
        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'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: UpdateClusterNetwork
      tags:
      - computeManagement
      x-example: "PUT /20160918/clusterNetworks/<var>&lt;cluster_network_OCID&gt;</var>\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"example_cluster_network\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterNetworkDetails'
        description: Update cluster network
        required: true
  /clusterNetworks/{clusterNetworkId}/actions/changeCompartment:
    post:
      description: 'Moves a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm)

        into a different compartment within the same tenancy. For

        information about moving resources between compartments, see

        [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        When you move a cluster network to a different compartment, associated resources such as the instances

        in the cluster network, boot volumes, and VNICs are not moved.

        '
      operationId: ChangeClusterNetworkCompartment
      parameters:
      - $ref: '#/components/parameters/ClusterNetworkIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: The Cluster Network Compartment Details is being changed.
          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
        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'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ChangeClusterNetworkCompartment
      tags:
      - computeManagement
      x-example: "​POST /20160918/clusterNetworks/<var>&lt;cluster_network_OCID&gt;</var>/actions/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;cluster_network_OCID&gt;</var>\",\n}\n"
      x-related-resource: '#/definitions/ClusterNetwork'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeClusterNetworkCompartmentDetails'
        description: Request to change the compartment of given cluster network.
        required: true
  /clusterNetworks/{clusterNetworkId}/instances:
    get:
      description: 'Lists the instances in a [cluster network with instance pools](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).

        '
      operationId: ListClusterNetworkInstances
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ClusterNetworkIdPathParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The list is being 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:
                items:
                  $ref: '#/components/schemas/InstanceSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListClusterNetworkInstances
      tags:
      - computeManagement
      x-example: 'GET /20160918/clusterNetworks/<var>&lt;cluster_network_OCID&gt;</var>/instances?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/ClusterNetwork'
  /instanceConfigurations:
    get:
      description: 'Lists the instance configurations in the specified compartment.

        '
      operationId: ListInstanceConfigurations
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The list is being 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:
                items:
                  $ref: '#/components/schemas/InstanceConfigurationSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListInstanceConfigurations
      tags:
      - computeManagement
    post:
      description: 'Creates an instance configuration. An instance configuration is a template that defines the

        settings to use when creating Compute instances.

        '
      operationId: CreateInstanceConfiguration
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The instance configuration.
          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/InstanceConfiguration'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: CreateInstanceConfiguration
      tags:
      - computeManagement
      x-example: "Example 1: Create an instance configuration by providing a list of configuration settings\nPOST /20160918/instanceConfigurations\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"example-instance-configuration\",\n  \"source\": \"NONE\",\n  \"instanceDetails\" : {\n    \"instanceType\": \"compute\",\n    \"blockVolumes\" : [ {\n      //Optional parameters for creating or attaching block volumes\n    } ],\n    \"launchDetails\" : {\n      \"compartmentId\":\"ocid1.tenancy.oc1..<var>&lt;unique_ID&gt;</var>\",\n      \"shape\":\"VM.Standard2.1\",\n      \"sourceDetails\": {\n          \"sourceType\": \"image\",\n          \"imageId\": \"oci.image.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n      },\n      //Optional parameters for configuring settings such as\n      //the availability domain, primary VNIC, and instance metadata\n    },\n    \"secondaryVnics\" : [ {\n      //Optional parameters for attaching secondary VNICs\n    } ]\n  }\n}\n\nExample 2: Create an instance configuration using an existing instance as a template\nPOST /20160918/instanceConfigurations\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"example-instance-configuration\",\n  \"source\": \"INSTANCE\",\n  \"instanceId\" : \"ocid1.instance.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstanceConfigurationBase'
        description: Instance configuration creation details
        required: true
  /instanceConfigurations/{instanceConfigurationId}:
    delete:
      description: Deletes an instance configuration.
      operationId: DeleteInstanceConfiguration
      parameters:
      - $ref: '#/components/parameters/InstanceConfigurationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: The instance configuration is being 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
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: DeleteInstanceConfiguration
      tags:
      - computeManagement
    get:
      description: Gets the specified instance configuration
      operationId: GetInstanceConfiguration
      parameters:
      - $ref: '#/components/parameters/InstanceConfigurationIdPathParam'
      responses:
        200:
          description: The instance configuration 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/InstanceConfiguration'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetInstanceConfiguration
      tags:
      - computeManagement
    put:
      description: Updates the free-form tags, defined tags, and display name of an instance configuration.
      operationId: UpdateInstanceConfiguration
      parameters:
      - $ref: '#/components/parameters/InstanceConfigurationIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The instance configuration was updated
          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/InstanceConfiguration'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: UpdateInstanceConfiguration
      tags:
      - computeManagement
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInstanceConfigurationDetails'
        description: Updates the freeFormTags, definedTags, and display name of an instance configuration.
        required: true
  /instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment:
    post:
      description: 'Moves an instance configuration into a different compartment within the same tenancy.

        For information about moving resources between compartments, see

        [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        When you move an instance configuration to a different compartment, associated resources such as

        instance pools are not moved.


        **Important:** Most of the properties for an existing instance configuration, including the compartment,

        cannot be modified after you create the instance configuration. Although you can move an instance configuration

        to a different compartment, you will not be able to use the instance configuration to manage instance pools

        in the new compartment. If you want to update an instance configuration to point to a different compartment,

        you should instead create a new instance configuration in the target compartment using

        [CreateInstanceConfiguration](/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).

        '
      operationId: ChangeInstanceConfigurationCompartment
      parameters:
      - $ref: '#/components/parameters/InstanceConfigurationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: The Instance Configuration Compartment Details is getting changed
          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
        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'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ChangeInstanceConfigurationCompartment
      tags:
      - computeManagement
      x-example: "POST /20160918/instanceConfigurations/<var>&lt;instance_configuration_OCID&gt;</var>/actions/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/InstanceConfiguration'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeInstanceConfigurationCompartmentDetails'
        description: Request to change the compartment of given instance configuration.
        required: true
  /instanceConfigurations/{instanceConfigurationId}/actions/launch:
    post:
      description: 'Creates an instance from an instance configuration.


        If the instance configuration does not include all of the parameters that are

        required to create an instance, such as the availability domain and subnet ID, you must

        provide these parameters when you create an instance from the instance configuration.

        For more information, see the [InstanceConfiguration](#/en/iaas/latest/InstanceConfiguration/)

        resource.


        To determine whether capacity is available for a specific shape before you create an instance,

        use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport)

        operation.

        '
      operationId: LaunchInstanceConfiguration
      parameters:
      - $ref: '#/components/parameters/InstanceConfigurationIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OpcComputeClusterIdHeader'
      responses:
        200:
          description: The instance that was launched.
          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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Con

# --- truncated at 32 KB (187 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-computemanagement-api-openapi.yml