Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Core Services Compute Management API
34 actions
34 updates
phrasing
extends
openapi/oracle-cloud-computemanagement-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Oracle Cloud Infrastructure's API. It is a proposal applied on top of the contract, not a document Oracle Cloud Infrastructure publishes.
What the actions change
x-apievangelist-phrasing
Targets 34 · first 16 shown; the file carries all of them
$.info
$.paths['/clusterNetworks'].get
$.paths['/clusterNetworks'].post
$.paths['/clusterNetworks/{clusterNetworkId}'].get
$.paths['/clusterNetworks/{clusterNetworkId}'].put
$.paths['/clusterNetworks/{clusterNetworkId}'].delete
$.paths['/clusterNetworks/{clusterNetworkId}/actions/changeCompartment'].post
$.paths['/clusterNetworks/{clusterNetworkId}/instances'].get
$.paths['/instanceConfigurations'].get
$.paths['/instanceConfigurations'].post
$.paths['/instanceConfigurations/{instanceConfigurationId}'].get
$.paths['/instanceConfigurations/{instanceConfigurationId}'].put
$.paths['/instanceConfigurations/{instanceConfigurationId}'].delete
$.paths['/instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment'].post
$.paths['/instanceConfigurations/{instanceConfigurationId}/actions/launch'].post
$.paths['/instancePools'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Core Services Compute Management API
version: 1.0.0
extends: openapi/oracle-cloud-computemanagement-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 33
- target: $.paths['/clusterNetworks'].get
update:
x-apievangelist-phrasing:
intent: List cluster networks in a compartment
effect: read
questions:
- Which RDMA cluster networks with instance pools do I have in my compartment?
- Can I filter my cluster networks by name or lifecycle state?
instructions:
- text: List the cluster networks in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: Find cluster networks named {displayName} in compartment {compartmentId}.
slots:
displayName: query.displayName
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/clusterNetworks'].post
update:
x-apievangelist-phrasing:
intent: Create an RDMA cluster network with instance pools
effect: write
questions:
- How do I set up a low-latency RDMA network of GPU or HPC bare metal instances?
- What instance pools and placement do I need to create a cluster network?
instructions:
- text: Create a cluster network in compartment {compartmentId} with instance pools {instancePools} and placement {placementConfiguration}.
slots:
compartmentId: requestBody.compartmentId
instancePools: requestBody.instancePools
placementConfiguration: requestBody.placementConfiguration
- text: Build an HPC cluster network called {displayName} in compartment {compartmentId} using pools {instancePools} placed at {placementConfiguration}.
slots:
displayName: requestBody.displayName
compartmentId: requestBody.compartmentId
instancePools: requestBody.instancePools
placementConfiguration: requestBody.placementConfiguration
method: generated
generated: '2026-09-26'
- target: $.paths['/clusterNetworks/{clusterNetworkId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a cluster network
effect: read
questions:
- What instance pools and state does my cluster network have?
- Can I look up one RDMA cluster network's configuration?
instructions:
- text: Show cluster network {clusterNetworkId}.
slots:
clusterNetworkId: path.clusterNetworkId
- text: Get the configuration and state of cluster network {clusterNetworkId}.
slots:
clusterNetworkId: path.clusterNetworkId
method: generated
generated: '2026-09-26'
- target: $.paths['/clusterNetworks/{clusterNetworkId}'].put
update:
x-apievangelist-phrasing:
intent: Update a cluster network
effect: write
questions:
- Can I resize the instance pools inside an existing cluster network?
- How do I rename a cluster network without changing its OCID?
instructions:
- text: Rename cluster network {clusterNetworkId} to {displayName}.
slots:
clusterNetworkId: path.clusterNetworkId
displayName: requestBody.displayName
- text: Update the instance pools of cluster network {clusterNetworkId} to {instancePools}.
slots:
clusterNetworkId: path.clusterNetworkId
instancePools: requestBody.instancePools
method: generated
generated: '2026-09-26'
- target: $.paths['/clusterNetworks/{clusterNetworkId}'].delete
update:
x-apievangelist-phrasing:
intent: Terminate a cluster network and its instances
effect: destructive
questions:
- What gets deleted when I terminate a cluster network?
- How do I permanently remove an RDMA cluster network along with its pools?
instructions:
- text: Terminate cluster network {clusterNetworkId} including its instances and pools.
slots:
clusterNetworkId: path.clusterNetworkId
- text: Permanently delete cluster network {clusterNetworkId}.
slots:
clusterNetworkId: path.clusterNetworkId
method: generated
generated: '2026-09-26'
- target: $.paths['/clusterNetworks/{clusterNetworkId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move a cluster network to another compartment
effect: write
questions:
- Can I move a cluster network into a different compartment in the same tenancy?
- Which call relocates an RDMA cluster network between compartments?
instructions:
- text: Move cluster network {clusterNetworkId} to compartment {compartmentId}.
slots:
clusterNetworkId: path.clusterNetworkId
compartmentId: requestBody.compartmentId
- text: Relocate cluster network {clusterNetworkId} into compartment {compartmentId}.
slots:
clusterNetworkId: path.clusterNetworkId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/clusterNetworks/{clusterNetworkId}/instances'].get
update:
x-apievangelist-phrasing:
intent: List instances in a cluster network
effect: read
questions:
- Which compute instances belong to my cluster network?
- Can I search a cluster network's instances by display name?
instructions:
- text: List the instances in cluster network {clusterNetworkId}, compartment {compartmentId}.
slots:
clusterNetworkId: path.clusterNetworkId
compartmentId: query.compartmentId
- text: Find instances named {displayName} in cluster network {clusterNetworkId} under compartment {compartmentId}.
slots:
displayName: query.displayName
clusterNetworkId: path.clusterNetworkId
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations'].get
update:
x-apievangelist-phrasing:
intent: List instance configurations in a compartment
effect: read
questions:
- What instance configuration templates do I have saved in my compartment?
- Which launch templates exist for creating compute instances?
instructions:
- text: List the instance configurations in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: Show all instance launch templates in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations'].post
update:
x-apievangelist-phrasing:
intent: Create an instance configuration template
effect: write
questions:
- How do I save a reusable template of settings for launching compute instances?
- Can I base an instance configuration on an existing instance?
instructions:
- text: Create an instance configuration named {displayName} in compartment {compartmentId}.
slots:
displayName: requestBody.displayName
compartmentId: requestBody.compartmentId
- text: Create an instance configuration in compartment {compartmentId} from source {source}.
slots:
compartmentId: requestBody.compartmentId
source: requestBody.source
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations/{instanceConfigurationId}'].get
update:
x-apievangelist-phrasing:
intent: Get an instance configuration
effect: read
questions:
- What launch settings are stored in a particular instance configuration?
- Can I inspect an instance configuration before launching from it?
instructions:
- text: Show instance configuration {instanceConfigurationId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
- text: Get the launch details stored in instance configuration {instanceConfigurationId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations/{instanceConfigurationId}'].put
update:
x-apievangelist-phrasing:
intent: Rename or retag an instance configuration
effect: write
questions:
- Can I change the name or tags on an instance configuration?
- Which fields of an instance configuration can be edited after creation?
instructions:
- text: Rename instance configuration {instanceConfigurationId} to {displayName}.
slots:
instanceConfigurationId: path.instanceConfigurationId
displayName: requestBody.displayName
- text: Set freeform tags {freeformTags} on instance configuration {instanceConfigurationId}.
slots:
freeformTags: requestBody.freeformTags
instanceConfigurationId: path.instanceConfigurationId
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations/{instanceConfigurationId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an instance configuration
effect: destructive
questions:
- How do I delete an instance configuration template I no longer use?
- Can I remove an old launch template from my compartment?
instructions:
- text: Delete instance configuration {instanceConfigurationId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
- text: Remove the launch template {instanceConfigurationId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move an instance configuration to another compartment
effect: write
questions:
- Can I move an instance configuration into a different compartment?
- What relocates a launch template to another compartment in my tenancy?
instructions:
- text: Move instance configuration {instanceConfigurationId} to compartment {compartmentId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
compartmentId: requestBody.compartmentId
- text: Relocate launch template {instanceConfigurationId} into compartment {compartmentId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/instanceConfigurations/{instanceConfigurationId}/actions/launch'].post
update:
x-apievangelist-phrasing:
intent: Launch an instance from an instance configuration
effect: write
questions:
- How do I launch a compute instance from a saved instance configuration?
- What if my instance configuration is missing the availability domain or subnet?
instructions:
- text: Launch a {instanceType} instance from instance configuration {instanceConfigurationId}.
slots:
instanceType: requestBody.instanceType
instanceConfigurationId: path.instanceConfigurationId
- text: Create an instance from template {instanceConfigurationId} of type {instanceType} in compute cluster {computeClusterId}.
slots:
instanceConfigurationId: path.instanceConfigurationId
instanceType: requestBody.instanceType
computeClusterId: header.opc-compute-cluster-id
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools'].get
update:
x-apievangelist-phrasing:
intent: List instance pools in a compartment
effect: read
questions:
- What instance pools are running in my compartment?
- Can I find instance pools by name or only those that are stopped?
instructions:
- text: List instance pools in compartment {compartmentId}.
slots:
compartmentId: query.compartmentId
- text: Show instance pools in compartment {compartmentId} in state {lifecycleState}.
slots:
compartmentId: query.compartmentId
lifecycleState: query.lifecycleState
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools'].post
update:
x-apievangelist-phrasing:
intent: Create an instance pool
effect: write
questions:
- How do I create a group of identical instances managed together?
- Which instance configuration and size do I need for a new instance pool?
instructions:
- text: Create a pool of {size} instances from {instanceConfigurationId} in compartment {compartmentId}, placed at {placementConfigurations}.
slots:
size: requestBody.size
instanceConfigurationId: requestBody.instanceConfigurationId
compartmentId: requestBody.compartmentId
placementConfigurations: requestBody.placementConfigurations
- text: 'Stand up pool {displayName}: {size} instances of {instanceConfigurationId} at {placementConfigurations} in {compartmentId}.'
slots:
displayName: requestBody.displayName
size: requestBody.size
instanceConfigurationId: requestBody.instanceConfigurationId
placementConfigurations: requestBody.placementConfigurations
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of an instance pool
effect: read
questions:
- How many instances is my instance pool set to run?
- Which instance configuration is a pool currently using?
instructions:
- text: Show instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
- text: Get the size and configuration of instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}'].put
update:
x-apievangelist-phrasing:
intent: Resize or reconfigure an instance pool
effect: write
questions:
- How do I scale an instance pool up or down?
- Can I switch an instance pool to a newer instance configuration?
instructions:
- text: Resize instance pool {instancePoolId} to {size} instances.
slots:
instancePoolId: path.instancePoolId
size: requestBody.size
- text: Point instance pool {instancePoolId} at instance configuration {instanceConfigurationId}.
slots:
instancePoolId: path.instancePoolId
instanceConfigurationId: requestBody.instanceConfigurationId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}'].delete
update:
x-apievangelist-phrasing:
intent: Terminate an instance pool and its instances
effect: destructive
questions:
- What happens to the instances when I terminate an instance pool?
- How do I permanently delete an instance pool and everything it created?
instructions:
- text: Terminate instance pool {instancePoolId} and its instances.
slots:
instancePoolId: path.instancePoolId
- text: Permanently delete instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/attachLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Attach a load balancer to an instance pool
effect: write
questions:
- How do I put an instance pool behind a load balancer?
- Which backend set and port do I specify when attaching a load balancer to a pool?
instructions:
- text: Attach load balancer {loadBalancerId} backend set {backendSetName} on port {port} to instance pool {instancePoolId} using VNIC {vnicSelection}.
slots:
loadBalancerId: requestBody.loadBalancerId
backendSetName: requestBody.backendSetName
port: requestBody.port
instancePoolId: path.instancePoolId
vnicSelection: requestBody.vnicSelection
- text: Register instance pool {instancePoolId} with load balancer {loadBalancerId} in backend set {backendSetName}, port {port}, VNIC {vnicSelection}.
slots:
instancePoolId: path.instancePoolId
loadBalancerId: requestBody.loadBalancerId
backendSetName: requestBody.backendSetName
port: requestBody.port
vnicSelection: requestBody.vnicSelection
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/changeCompartment'].post
update:
x-apievangelist-phrasing:
intent: Move an instance pool to another compartment
effect: write
questions:
- Can I move an instance pool into a different compartment?
- Which call relocates an instance pool within my tenancy?
instructions:
- text: Move instance pool {instancePoolId} to compartment {compartmentId}.
slots:
instancePoolId: path.instancePoolId
compartmentId: requestBody.compartmentId
- text: Relocate instance pool {instancePoolId} into compartment {compartmentId}.
slots:
instancePoolId: path.instancePoolId
compartmentId: requestBody.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/detachInstance'].post
update:
x-apievangelist-phrasing:
intent: Detach an instance from an instance pool
effect: write
questions:
- How do I take one instance out of an instance pool?
- When detaching an instance, can I terminate it and shrink the pool size too?
instructions:
- text: Detach instance {instanceId} from instance pool {instancePoolId}.
slots:
instanceId: requestBody.instanceId
instancePoolId: path.instancePoolId
- text: Remove instance {instanceId} from pool {instancePoolId}, terminate it and decrease the pool size.
slots:
instanceId: requestBody.instanceId
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/detachLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Detach a load balancer from an instance pool
effect: write
questions:
- How do I remove a load balancer from an instance pool?
- Can I stop an instance pool from serving traffic through a particular backend set?
instructions:
- text: Detach load balancer {loadBalancerId} backend set {backendSetName} from instance pool {instancePoolId}.
slots:
loadBalancerId: requestBody.loadBalancerId
backendSetName: requestBody.backendSetName
instancePoolId: path.instancePoolId
- text: Unhook instance pool {instancePoolId} from backend set {backendSetName} on load balancer {loadBalancerId}.
slots:
instancePoolId: path.instancePoolId
backendSetName: requestBody.backendSetName
loadBalancerId: requestBody.loadBalancerId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/reset'].post
update:
x-apievangelist-phrasing:
intent: Hard reset every instance in a pool
effect: write
questions:
- Can I immediately power cycle all instances in an instance pool?
- What does a hard reset do to the instances in my pool?
instructions:
- text: Hard reset all instances in instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
- text: Immediately power off and back on every instance in pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/softreset'].post
update:
x-apievangelist-phrasing:
intent: Gracefully reboot every instance in a pool
effect: write
questions:
- How do I gracefully reboot all instances in a pool with an OS shutdown first?
- Is there a soft reset that lets the operating systems shut down cleanly before restarting?
instructions:
- text: Soft reset all instances in instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
- text: Gracefully reboot the instances in pool {instancePoolId} with an ACPI shutdown.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/softstop'].post
update:
x-apievangelist-phrasing:
intent: Soft stop every instance in a pool
effect: write
questions:
- Can I send a soft stop to all instances in a pool so their operating systems shut down cleanly?
- What does the softstop action do to instances in an instance pool?
instructions:
- text: Soft stop all instances in instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
- text: Run the softstop action on pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/start'].post
update:
x-apievangelist-phrasing:
intent: Start every instance in a pool
effect: write
questions:
- How do I power on all the instances in a stopped instance pool?
- Can I start an entire instance pool with one call?
instructions:
- text: Start instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
- text: Power on every instance in pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/stop'].post
update:
x-apievangelist-phrasing:
intent: Immediately power off every instance in a pool
effect: write
questions:
- Can I stop all instances in a pool immediately without waiting for an OS shutdown?
- What powers off an entire instance pool at once?
instructions:
- text: Stop instance pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
- text: Immediately power off all instances in pool {instancePoolId}.
slots:
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/actions/terminationProceed'].post
update:
x-apievangelist-phrasing:
intent: Mark a pool instance ready for termination
effect: destructive
questions:
- How do I signal that an instance in my pool is ready to be terminated?
- Can I let a pool instance proceed to termination once my cleanup is done?
instructions:
- text: Mark instance {instanceId} in pool {instancePoolId} as ready for termination.
slots:
instanceId: requestBody.instanceId
instancePoolId: path.instancePoolId
- text: Let pool {instancePoolId} proceed with terminating instance {instanceId}.
slots:
instancePoolId: path.instancePoolId
instanceId: requestBody.instanceId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/instances'].get
update:
x-apievangelist-phrasing:
intent: List instances in an instance pool
effect: read
questions:
- Which instances are currently members of my instance pool?
- Can I look up pool members by display name?
instructions:
- text: List the instances in instance pool {instancePoolId}, compartment {compartmentId}.
slots:
instancePoolId: path.instancePoolId
compartmentId: query.compartmentId
- text: Find instances named {displayName} in pool {instancePoolId} of compartment {compartmentId}.
slots:
displayName: query.displayName
instancePoolId: path.instancePoolId
compartmentId: query.compartmentId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/instances'].post
update:
x-apievangelist-phrasing:
intent: Attach an existing instance to an instance pool
effect: write
questions:
- Can I add an instance I already have into an instance pool?
- What prerequisites must an instance meet before joining a pool?
instructions:
- text: Attach instance {instanceId} to instance pool {instancePoolId}.
slots:
instanceId: requestBody.instanceId
instancePoolId: path.instancePoolId
- text: Add existing instance {instanceId} as a member of pool {instancePoolId}.
slots:
instanceId: requestBody.instanceId
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/instances/{instanceId}'].get
update:
x-apievangelist-phrasing:
intent: Get an instance's membership in an instance pool
effect: read
questions:
- What is the state of one particular instance within my pool?
- Can I check the pool membership details of a single instance?
instructions:
- text: Show instance {instanceId} in instance pool {instancePoolId}.
slots:
instanceId: path.instanceId
instancePoolId: path.instancePoolId
- text: Get the pool membership details of instance {instanceId} in pool {instancePoolId}.
slots:
instanceId: path.instanceId
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'
- target: $.paths['/instancePools/{instancePoolId}/loadBalancerAttachments/{instancePoolLoadBalancerAttachmentId}'].get
update:
x-apievangelist-phrasing:
intent: Get a load balancer attachment on an instance pool
effect: read
questions:
- Which load balancer and backend set is attached to my instance pool?
- Is a load balancer attachment on my pool attached or still in progress?
instructions:
- text: Show load balancer attachment {instancePoolLoadBalancerAttachmentId} on instance pool {instancePoolId}.
slots:
instancePoolLoadBalancerAttachmentId: path.instancePoolLoadBalancerAttachmentId
instancePoolId: path.instancePoolId
- text: Check the status of attachment {instancePoolLoadBalancerAttachmentId} between pool {instancePoolId} and its load balancer.
slots:
instancePoolLoadBalancerAttachmentId: path.instancePoolLoadBalancerAttachmentId
instancePoolId: path.instancePoolId
method: generated
generated: '2026-09-26'