{ "opencollection": "1.0.0", "info": { "name": "Core Services Compute API", "version": "20160918" }, "items": [ { "info": { "name": "compute", "type": "folder" }, "items": [ { "info": { "name": "ListAppCatalogListings", "type": "http" }, "http": { "method": "GET", "url": "/20160918/appCatalogListings", "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "publisherName", "value": "", "type": "query", "description": "A filter to return only the publisher that matches the given publisher name exactly.\n" }, { "name": "publisherType", "value": "", "type": "query", "description": "A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" } ] }, "docs": "Lists the published listings." }, { "info": { "name": "GetAppCatalogListing", "type": "http" }, "http": { "method": "GET", "url": "/20160918/appCatalogListings/:listingId", "params": [ { "name": "listingId", "value": "", "type": "path", "description": "The OCID of the listing." } ] }, "docs": "Gets the specified listing." }, { "info": { "name": "ListAppCatalogListingResourceVersions", "type": "http" }, "http": { "method": "GET", "url": "/20160918/appCatalogListings/:listingId/resourceVersions", "params": [ { "name": "listingId", "value": "", "type": "path", "description": "The OCID of the listing." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Gets all resource versions for a particular listing." }, { "info": { "name": "GetAppCatalogListingResourceVersion", "type": "http" }, "http": { "method": "GET", "url": "/20160918/appCatalogListings/:listingId/resourceVersions/:resourceVersion", "params": [ { "name": "listingId", "value": "", "type": "path", "description": "The OCID of the listing." }, { "name": "resourceVersion", "value": "", "type": "path", "description": "Listing Resource Version." } ] }, "docs": "Gets the specified listing resource version." }, { "info": { "name": "GetAppCatalogListingAgreements", "type": "http" }, "http": { "method": "GET", "url": "/20160918/appCatalogListings/:listingId/resourceVersions/:resourceVersion/agreements", "params": [ { "name": "listingId", "value": "", "type": "path", "description": "The OCID of the listing." }, { "name": "resourceVersion", "value": "", "type": "path", "description": "Listing Resource Version." } ] }, "docs": "Retrieves the agreements for a particular resource version of a listing." }, { "info": { "name": "ListAppCatalogSubscriptions", "type": "http" }, "http": { "method": "GET", "url": "/20160918/appCatalogSubscriptions", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "listingId", "value": "", "type": "query", "description": "A filter to return only the listings that matches the given listing id.\n" } ] }, "docs": "Lists subscriptions for a compartment." }, { "info": { "name": "CreateAppCatalogSubscription", "type": "http" }, "http": { "method": "POST", "url": "/20160918/appCatalogSubscriptions", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.\n" }, { "info": { "name": "DeleteAppCatalogSubscription", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/appCatalogSubscriptions", "params": [ { "name": "listingId", "value": "", "type": "query", "description": "The OCID of the listing." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "resourceVersion", "value": "", "type": "query", "description": "Listing Resource Version." } ] }, "docs": "Delete a subscription for a listing resource version for a compartment." }, { "info": { "name": "ListBootVolumeAttachments", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumeAttachments/", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "instanceId", "value": "", "type": "query", "description": "The OCID of the instance." }, { "name": "bootVolumeId", "value": "", "type": "query", "description": "The OCID of the boot volume." } ] }, "docs": "Lists the boot volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, boot volume OCID, or both.\n" }, { "info": { "name": "AttachBootVolume", "type": "http" }, "http": { "method": "POST", "url": "/20160918/bootVolumeAttachments/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified boot volume to the specified instance.\n" }, { "info": { "name": "GetBootVolumeAttachment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumeAttachments/:bootVolumeAttachmentId", "params": [ { "name": "bootVolumeAttachmentId", "value": "", "type": "path", "description": "The OCID of the boot volume attachment." } ] }, "docs": "Gets information about the specified boot volume attachment." }, { "info": { "name": "DetachBootVolume", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/bootVolumeAttachments/:bootVolumeAttachmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeAttachmentId", "value": "", "type": "path", "description": "The OCID of the boot volume attachment." } ] }, "docs": "Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n" }, { "info": { "name": "CreateComputeCapacityReport", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeCapacityReports", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a report of the host capacity within an availability domain that is available for you\nto create compute instances. Host capacity is the physical infrastructure that resources such as compute\ninstances run on.\n\nUse the capacity report to determine whether sufficient capacity is available for a shape before\nyou create an instance or change the shape of an instance.\n" }, { "info": { "name": "ListComputeCapacityReservationInstanceShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityReservationInstanceShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the shapes that can be reserved within the specified compartment.\n" }, { "info": { "name": "ListComputeCapacityReservations", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityReservations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the compute capacity reservations that match the specified criteria and compartment.\n\nYou can limit the list by specifying a compute capacity reservation display name\n(the list will include all the identically-named compute capacity reservations in the compartment).\n" }, { "info": { "name": "CreateComputeCapacityReservation", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeCapacityReservations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new compute capacity reservation in the specified compartment and availability domain.\nCompute capacity reservations let you reserve instances in a compartment.\nWhen you launch an instance using this reservation, you are assured that you have enough space for your instance,\nand you won't get out of capacity errors.\nFor more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).\n" }, { "info": { "name": "GetComputeCapacityReservation", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityReservations/:capacityReservationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "capacityReservationId", "value": "", "type": "path", "description": "The OCID of the compute capacity reservation." } ] }, "docs": "Gets information about the specified compute capacity reservation." }, { "info": { "name": "UpdateComputeCapacityReservation", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeCapacityReservations/:capacityReservationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "capacityReservationId", "value": "", "type": "path", "description": "The OCID of the compute capacity reservation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified capacity reservation and its associated capacity configurations.\nFields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteComputeCapacityReservation", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/computeCapacityReservations/:capacityReservationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "capacityReservationId", "value": "", "type": "path", "description": "The OCID of the compute capacity reservation." } ] }, "docs": "Deletes the specified compute capacity reservation." }, { "info": { "name": "ChangeComputeCapacityReservationCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeCapacityReservations/:capacityReservationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "capacityReservationId", "value": "", "type": "path", "description": "The OCID of the compute capacity reservation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute capacity reservation into a different compartment. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListComputeCapacityReservationInstances", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityReservations/:capacityReservationId/instances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "capacityReservationId", "value": "", "type": "path", "description": "The OCID of the compute capacity reservation." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.\n" }, { "info": { "name": "ListComputeCapacityTopologies", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityTopologies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute\ncapacity topology display name.\n" }, { "info": { "name": "CreateComputeCapacityTopology", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeCapacityTopologies", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new compute capacity topology in the specified compartment and availability domain.\n\nCompute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch\ninstances on your bare metal hosts with targeted network locations.\n\nCompute capacity topologies report the health status of your bare metal hosts.\n" }, { "info": { "name": "GetComputeCapacityTopology", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." } ] }, "docs": "Gets information about the specified compute capacity topology." }, { "info": { "name": "UpdateComputeCapacityTopology", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.\n" }, { "info": { "name": "DeleteComputeCapacityTopology", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." } ] }, "docs": "Deletes the specified compute capacity topology." }, { "info": { "name": "ChangeComputeCapacityTopologyCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute capacity topology into a different compartment. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListComputeCapacityTopologyComputeBareMetalHosts", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId/computeBareMetalHosts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." }, { "name": "computeHpcIslandId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island." }, { "name": "computeNetworkBlockId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block." }, { "name": "computeLocalBlockId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists compute bare metal hosts in the specified compute capacity topology." }, { "info": { "name": "ListComputeCapacityTopologyComputeHpcIslands", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId/computeHpcIslands", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists compute HPC islands in the specified compute capacity topology." }, { "info": { "name": "ListComputeCapacityTopologyComputeNetworkBlocks", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeCapacityTopologies/:computeCapacityTopologyId/computeNetworkBlocks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "computeCapacityTopologyId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology." }, { "name": "computeHpcIslandId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists compute network blocks in the specified compute capacity topology." }, { "info": { "name": "ListComputeCluster", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the compute clusters in the specified compartment.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.\n" }, { "info": { "name": "CreateComputeCluster", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an empty [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster\nis a remote direct memory access (RDMA) network group.\n\nAfter the compute cluster is created, you can use the compute cluster's OCID with the\n[LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster.\nThe instances must be created in the same compartment and availability domain as the cluster.\n\nUse compute clusters when you want to manage i" }, { "info": { "name": "GetComputeCluster", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeClusters/:computeClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory\naccess (RDMA) network group.\n" } ] }, "docs": "Gets information about a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm)\nis a remote direct memory access (RDMA) network group.\n" }, { "info": { "name": "UpdateComputeCluster", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeClusters/:computeClusterId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "computeClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory\naccess (RDMA) network group.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a\nremote direct memory access (RDMA) network group.\n\nTo create instances within a compute cluster, use the [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance)\noperation.\n\nTo delete instances from a compute cluster, use the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance)\noperation.\n" }, { "info": { "name": "DeleteComputeCluster", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/computeClusters/:computeClusterId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "computeClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory\naccess (RDMA) network group.\n" } ] }, "docs": "Deletes a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a\nremote direct memory access (RDMA) network group.\n\nBefore you delete a compute cluster, first delete all instances in the cluster by using\nthe [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance) operation.\n" }, { "info": { "name": "MoveComputeCluster", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeClusters/:computeClusterId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeClusterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory\naccess (RDMA) network group.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute cluster into a different compartment within the same tenancy.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.\n\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListComputeGlobalImageCapabilitySchemas", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGlobalImageCapabilitySchemas", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given compartment OCID exactly.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists Compute Global Image Capability Schema in the specified compartment.\n" }, { "info": { "name": "GetComputeGlobalImageCapabilitySchema", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGlobalImageCapabilitySchemas/:computeGlobalImageCapabilitySchemaId", "params": [ { "name": "computeGlobalImageCapabilitySchemaId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema" } ] }, "docs": "Gets the specified Compute Global Image Capability Schema" }, { "info": { "name": "ListComputeGlobalImageCapabilitySchemaVersions", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGlobalImageCapabilitySchemas/:computeGlobalImageCapabilitySchemaId/versions", "params": [ { "name": "computeGlobalImageCapabilitySchemaId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists Compute Global Image Capability Schema versions in the specified compartment.\n" }, { "info": { "name": "GetComputeGlobalImageCapabilitySchemaVersion", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGlobalImageCapabilitySchemas/:computeGlobalImageCapabilitySchemaId/versions/:computeGlobalImageCapabilitySchemaVersionName", "params": [ { "name": "computeGlobalImageCapabilitySchemaId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema" }, { "name": "computeGlobalImageCapabilitySchemaVersionName", "value": "", "type": "path", "description": "The name of the compute global image capability schema version" } ] }, "docs": "Gets the specified Compute Global Image Capability Schema Version" }, { "info": { "name": "ListComputeGpuMemoryClusters", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGpuMemoryClusters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeGpuMemoryClusterId", "value": "", "type": "query", "description": "A filter to return only the listings that matches the given GPU memory cluster id.\n" }, { "name": "computeGpuMemoryFabricId", "value": "", "type": "query", "description": "A filter to return only the listings that matches the given GPU memory fabric id.\n" }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "computeClusterId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory\naccess (RDMA) network group.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" } ] }, "docs": "List all of the compute GPU memory clusters.\n" }, { "info": { "name": "CreateComputeGpuMemoryCluster", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeGpuMemoryClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a compute GPU memory cluster instance on a specific compute GPU memory fabric\n" }, { "info": { "name": "GetComputeGpuMemoryCluster", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGpuMemoryClusters/:computeGpuMemoryClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeGpuMemoryClusterId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory cluster." } ] }, "docs": "Gets information about the specified compute GPU memory cluster\n" }, { "info": { "name": "UpdateComputeGpuMemoryCluster", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeGpuMemoryClusters/:computeGpuMemoryClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeGpuMemoryClusterId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a compute gpu memory cluster resource.\n" }, { "info": { "name": "DeleteComputeGpuMemoryCluster", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/computeGpuMemoryClusters/:computeGpuMemoryClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeGpuMemoryClusterId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory cluster." } ] }, "docs": "Terminates and deletes the specified compute GPU memory cluster and underlying instances." }, { "info": { "name": "ChangeComputeGpuMemoryClusterCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeGpuMemoryClusters/:computeGpuMemoryClusterId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeGpuMemoryClusterId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute GPU memory cluster into a different compartment. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListComputeGpuMemoryClustersInstances", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGpuMemoryClusters/:computeGpuMemoryClusterId/instances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeGpuMemoryClusterId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory cluster." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" } ] }, "docs": "List all of the GPU memory cluster instances.\n" }, { "info": { "name": "ListComputeGpuMemoryFabrics", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGpuMemoryFabrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeGpuMemoryFabricId", "value": "", "type": "query", "description": "A filter to return only the listings that matches the given GPU memory fabric id.\n" }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "computeHpcIslandId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island." }, { "name": "computeNetworkBlockId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block." }, { "name": "computeGpuMemoryFabricLifecycleState", "value": "", "type": "query", "description": "A filter to return ComputeGpuMemoryFabricSummary resources that match the given lifecycle state.\n" }, { "name": "computeGpuMemoryFabricHealth", "value": "", "type": "query", "description": "A filter to return ComputeGpuMemoryFabricSummary resources that match the given fabric health.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the compute GPU memory fabrics that match the specified criteria and compartmentId." }, { "info": { "name": "GetComputeGpuMemoryFabric", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeGpuMemoryFabrics/:computeGpuMemoryFabricId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeGpuMemoryFabricId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory fabric." } ] }, "docs": "Gets information about the specified compute GPU memory fabric\n" }, { "info": { "name": "UpdateComputeGpuMemoryFabric", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeGpuMemoryFabrics/:computeGpuMemoryFabricId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeGpuMemoryFabricId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory fabric." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Customer can update displayName, tags and desired firmware bundle, recycle level for \ncompute GPU memory fabric record\n" }, { "info": { "name": "ChangeComputeGpuMemoryFabricCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeGpuMemoryFabrics/:computeGpuMemoryFabricId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeGpuMemoryFabricId", "value": "", "type": "path", "description": "The OCID of the compute GPU memory fabric." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute GPU memory fabric into a different compartment. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListComputeHostGroups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeHostGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" } ] }, "docs": "Lists the compute host groups that match the specified criteria and compartment." }, { "info": { "name": "CreateComputeHostGroup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHostGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new compute host group in the specified compartment and availability domain." }, { "info": { "name": "GetComputeHostGroup", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeHostGroups/:computeHostGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeHostGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.\n" } ] }, "docs": "Gets information about the specified compute host group" }, { "info": { "name": "UpdateComputeHostGroup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeHostGroups/:computeHostGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeHostGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified compute host group details." }, { "info": { "name": "DeleteComputeHostGroup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/computeHostGroups/:computeHostGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "computeHostGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.\n" } ] }, "docs": "Deletes the specified compute host group" }, { "info": { "name": "ChangeComputeHostGroupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHostGroups/:computeHostGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeHostGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute host group into a different compartment. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListComputeHosts", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeHosts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "networkResourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host network resoruce.\n- Customer-unique HPC island ID\n- Customer-unique network block ID\n- Customer-unique local block ID\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "computeHostLifecycleState", "value": "", "type": "query", "description": "A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.\n" }, { "name": "computeHostHealth", "value": "", "type": "query", "description": "A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.\n" }, { "name": "computeHostGroupId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.\n" }, { "name": "computeHostInSubtree", "value": "", "type": "query", "description": "When set to true, all the compartments in the tenancy are traversed\nand the hosts in the specified tenancy and its compartments are fetched.\nDefault is false.\n" } ] }, "docs": "Generates a list of summary host details\n" }, { "info": { "name": "GetComputeHost", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeHosts/:computeHostId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ] }, "docs": "Gets information about the specified compute host\n" }, { "info": { "name": "UpdateComputeHost", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeHosts/:computeHostId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Customer can update the some fields for ComputeHost record\n" }, { "info": { "name": "ApplyHostConfiguration", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHosts/:computeHostId/actions/applyConfiguration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ] }, "docs": "Triggers the asynchronous process that applies the host's target configuration" }, { "info": { "name": "AttachComputeHostGroupHost", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHosts/:computeHostId/actions/attachToHostGroup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the Compute BM Host to a Host group" }, { "info": { "name": "ChangeComputeHostCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHosts/:computeHostId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute host into a different compartment. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "CheckHostConfiguration", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHosts/:computeHostId/actions/checkConfiguration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ] }, "docs": "Marks the host to be checked for conformance to its target configuration" }, { "info": { "name": "DetachComputeHostGroupHost", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeHosts/:computeHostId/actions/detachFromHostGroup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeHostId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detaches the specified bare metal host from the compute host group" }, { "info": { "name": "ListComputeImageCapabilitySchemas", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeImageCapabilitySchemas", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given compartment OCID exactly.\n" }, { "name": "imageId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.\n" }, { "info": { "name": "CreateComputeImageCapabilitySchema", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeImageCapabilitySchemas", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates compute image capability schema.\n" }, { "info": { "name": "GetComputeImageCapabilitySchema", "type": "http" }, "http": { "method": "GET", "url": "/20160918/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId", "params": [ { "name": "computeImageCapabilitySchemaId", "value": "", "type": "path", "description": "The id of the compute image capability schema or the image ocid" }, { "name": "isMergeEnabled", "value": "", "type": "query", "description": "Merge the image capability schema with the global image capability schema\n" } ] }, "docs": "Gets the specified Compute Image Capability Schema\n" }, { "info": { "name": "UpdateComputeImageCapabilitySchema", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "computeImageCapabilitySchemaId", "value": "", "type": "path", "description": "The id of the compute image capability schema or the image ocid" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Compute Image Capability Schema\n" }, { "info": { "name": "DeleteComputeImageCapabilitySchema", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "computeImageCapabilitySchemaId", "value": "", "type": "path", "description": "The id of the compute image capability schema or the image ocid" } ] }, "docs": "Deletes the specified Compute Image Capability Schema\n" }, { "info": { "name": "ChangeComputeImageCapabilitySchemaCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/computeImageCapabilitySchemas/:computeImageCapabilitySchemaId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "computeImageCapabilitySchemaId", "value": "", "type": "path", "description": "The id of the compute image capability schema or the image ocid" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a compute image capability schema into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListDedicatedVmHostInstanceShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dedicatedVmHostInstanceShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "dedicatedVmHostShape", "value": "", "type": "query", "description": "Dedicated VM host shape name\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.\nYou can filter the list by compatibility with a specific dedicated virtual machine host shape.\n" }, { "info": { "name": "ListDedicatedVmHostShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dedicatedVmHostShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "instanceShapeName", "value": "", "type": "query", "description": "The name for the instance's shape.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.\n" }, { "info": { "name": "ListDedicatedVmHosts", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dedicatedVmHosts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "instanceShapeName", "value": "", "type": "query", "description": "The name for the instance's shape.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "remainingMemoryInGBsGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The remaining memory of the dedicated VM host, in GBs." }, { "name": "remainingOcpusGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The available OCPUs of the dedicated VM host." }, { "name": "isMemoryEncryptionEnabled", "value": "", "type": "query", "description": "A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.\n" } ] }, "docs": "Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.\n\nYou can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named\ndedicated virtual machine hosts in the compartment.\n" }, { "info": { "name": "CreateDedicatedVmHost", "type": "http" }, "http": { "method": "POST", "url": "/20160918/dedicatedVmHosts", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.\nDedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers\nthat are a single tenant and not shared with other customers.\nFor more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).\n" }, { "info": { "name": "GetDedicatedVmHost", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dedicatedVmHosts/:dedicatedVmHostId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dedicatedVmHostId", "value": "", "type": "path", "description": "The OCID of the dedicated VM host." } ] }, "docs": "Gets information about the specified dedicated virtual machine host." }, { "info": { "name": "UpdateDedicatedVmHost", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/dedicatedVmHosts/:dedicatedVmHostId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dedicatedVmHostId", "value": "", "type": "path", "description": "The OCID of the dedicated VM host." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.\nIf an attribute value is not included, it will not be updated.\n" }, { "info": { "name": "DeleteDedicatedVmHost", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/dedicatedVmHosts/:dedicatedVmHostId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dedicatedVmHostId", "value": "", "type": "path", "description": "The OCID of the dedicated VM host." } ] }, "docs": "Deletes the specified dedicated virtual machine host.\n\nIf any VM instances are assigned to the dedicated virtual machine host,\nthe delete operation will fail and the service will return a 409 response code.\n" }, { "info": { "name": "ChangeDedicatedVmHostCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/dedicatedVmHosts/:dedicatedVmHostId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dedicatedVmHostId", "value": "", "type": "path", "description": "The OCID of the dedicated VM host." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a dedicated virtual machine host from one compartment to another." }, { "info": { "name": "ListDedicatedVmHostInstances", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dedicatedVmHosts/:dedicatedVmHostId/instances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "dedicatedVmHostId", "value": "", "type": "path", "description": "The OCID of the dedicated VM host." }, { "name": "isMemoryEncryptionEnabled", "value": "", "type": "query", "description": "A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.\n" }, { "info": { "name": "ListFirmwareBundles", "type": "http" }, "http": { "method": "GET", "url": "/20160918/firmwareBundles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "platform", "value": "", "type": "query", "description": "platform name" }, { "name": "isDefaultBundle", "value": "", "type": "query", "description": "If true, return only the default firmware bundle for a given platform. Default is false." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" } ] }, "docs": "Gets a list of all Firmware Bundles in a compartment for specified platform. Can filter results to include \nonly the default (recommended) Firmware Bundle for the given platform.\n" }, { "info": { "name": "GetFirmwareBundle", "type": "http" }, "http": { "method": "GET", "url": "/20160918/firmwareBundles/:firmwareBundleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "firmwareBundleId", "value": "", "type": "path", "description": "Unique identifier for the firmware bundle." } ] }, "docs": "Returns the Firmware Bundle matching the provided firmwareBundleId.\n" }, { "info": { "name": "ListImages", "type": "http" }, "http": { "method": "GET", "url": "/20160918/images", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "operatingSystem", "value": "", "type": "query", "description": "The image's operating system.\n\nExample: `Oracle Linux`\n" }, { "name": "operatingSystemVersion", "value": "", "type": "query", "description": "The image's operating system version.\n\nExample: `7.2`\n" }, { "name": "shape", "value": "", "type": "query", "description": "Shape name." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n" } ] }, "docs": "Lists a subset of images available in the specified compartment, including\n[platform images](/iaas/Content/Compute/References/images.htm) and\n[custom images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).\nThe list of platform images includes the three most recently published versions\nof each major distribution. The list does not support filtering based on image tags.\n\nThe list of images returned is ordered to first show the recent platform images,\nthen all of the custom images.\n\n**Cautio" }, { "info": { "name": "CreateImage", "type": "http" }, "http": { "method": "POST", "url": "/20160918/images", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.\n\nWhen creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and\nthe OCID of the compartment containing that instance. For more information about images,\nsee [Managing Custom Images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).\n\nWhen importing an exported image from Object Storage, you specify" }, { "info": { "name": "GetImage", "type": "http" }, "http": { "method": "GET", "url": "/20160918/images/:imageId", "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." } ] }, "docs": "Gets the specified image." }, { "info": { "name": "UpdateImage", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/images/:imageId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the display name of the image. Avoid entering confidential information.\n" }, { "info": { "name": "DeleteImage", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/images/:imageId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." } ] }, "docs": "Deletes an image." }, { "info": { "name": "ChangeImageCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/images/:imageId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an image into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ExportImage", "type": "http" }, "http": { "method": "POST", "url": "/20160918/images/:imageId/actions/export", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL,\nor the namespace, bucket name, and object name when specifying the location to export to.\n\nFor more information about exporting images, see [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nTo perform an image export, you need write access to the Object Storage bucket for the image,\nsee [Let Users Write Objects to Object Storage Buckets](/iaas/Conten" }, { "info": { "name": "ListImageShapeCompatibilityEntries", "type": "http" }, "http": { "method": "GET", "url": "/20160918/images/:imageId/shapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the compatible shapes for the specified image." }, { "info": { "name": "GetImageShapeCompatibilityEntry", "type": "http" }, "http": { "method": "GET", "url": "/20160918/images/:imageId/shapes/:shapeName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." }, { "name": "shapeName", "value": "", "type": "path", "description": "Shape name." } ] }, "docs": "Retrieves an image shape compatibility entry." }, { "info": { "name": "AddImageShapeCompatibilityEntry", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/images/:imageId/shapes/:shapeName", "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." }, { "name": "shapeName", "value": "", "type": "path", "description": "Shape name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a shape to the compatible shapes list for the image." }, { "info": { "name": "RemoveImageShapeCompatibilityEntry", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/images/:imageId/shapes/:shapeName", "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image." }, { "name": "shapeName", "value": "", "type": "path", "description": "Shape name." } ] }, "docs": "Removes a shape from the compatible shapes list for the image." }, { "info": { "name": "ListInstanceConsoleConnections", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceConsoleConnections", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "instanceId", "value": "", "type": "query", "description": "The OCID of the instance." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the console connections for the specified compartment or instance.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n" }, { "info": { "name": "CreateInstanceConsoleConnection", "type": "http" }, "http": { "method": "POST", "url": "/20160918/instanceConsoleConnections", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new console connection to the specified instance.\nAfter the console connection has been created and is available,\nyou connect to the console using SSH.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n" }, { "info": { "name": "GetInstanceConsoleConnection", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceConsoleConnections/:instanceConsoleConnectionId", "params": [ { "name": "instanceConsoleConnectionId", "value": "", "type": "path", "description": "The OCID of the instance console connection." } ] }, "docs": "Gets the specified instance console connection's information." }, { "info": { "name": "UpdateInstanceConsoleConnection", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/instanceConsoleConnections/:instanceConsoleConnectionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceConsoleConnectionId", "value": "", "type": "path", "description": "The OCID of the instance console connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the defined tags and free-form tags for the specified instance console connection." }, { "info": { "name": "DeleteInstanceConsoleConnection", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/instanceConsoleConnections/:instanceConsoleConnectionId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceConsoleConnectionId", "value": "", "type": "path", "description": "The OCID of the instance console connection." } ] }, "docs": "Deletes the specified instance console connection." }, { "info": { "name": "ListConsoleHistories", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceConsoleHistories/", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "instanceId", "value": "", "type": "query", "description": "The OCID of the instance." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n" } ] }, "docs": "Lists the console history metadata for the specified compartment or instance.\n" }, { "info": { "name": "CaptureConsoleHistory", "type": "http" }, "http": { "method": "POST", "url": "/20160918/instanceConsoleHistories/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Captures the most recent serial console data (up to a megabyte) for the\nspecified instance.\n\nThe `CaptureConsoleHistory` operation works with the other console history operations\nas described below.\n\n1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the\nmost recent console history. This call returns a `ConsoleHistory`\nobject. The object will have a state of REQUESTED.\n2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with\nthe identifier of the" }, { "info": { "name": "GetConsoleHistory", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceConsoleHistories/:instanceConsoleHistoryId", "params": [ { "name": "instanceConsoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ] }, "docs": "Shows the metadata for the specified console history.\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n" }, { "info": { "name": "UpdateConsoleHistory", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/instanceConsoleHistories/:instanceConsoleHistoryId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceConsoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified console history metadata." }, { "info": { "name": "DeleteConsoleHistory", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/instanceConsoleHistories/:instanceConsoleHistoryId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceConsoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." } ] }, "docs": "Deletes the specified console history metadata and the console history data.\n" }, { "info": { "name": "GetConsoleHistoryContent", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceConsoleHistories/:instanceConsoleHistoryId/data", "params": [ { "name": "instanceConsoleHistoryId", "value": "", "type": "path", "description": "The OCID of the console history." }, { "name": "offset", "value": "", "type": "query", "description": "Offset of the snapshot data to retrieve." }, { "name": "length", "value": "", "type": "query", "description": "Length of the snapshot data to retrieve." } ] }, "docs": "Gets the actual console history data (not the metadata).\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n" }, { "info": { "name": "ListInstanceMaintenanceEvents", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceMaintenanceEvents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "instanceId", "value": "", "type": "query", "description": "The OCID of the instance." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state." }, { "name": "correlationToken", "value": "", "type": "query", "description": "A filter to only return resources that have a matching correlationToken." }, { "name": "instanceAction", "value": "", "type": "query", "description": "A filter to only return resources that match the given instance action." }, { "name": "timeWindowStartGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Starting range to return the maintenances which are not completed (date-time is in [RFC3339](https://tools.ietf.org/html/rfc3339) format)." }, { "name": "timeWindowStartLessThanOrEqualTo", "value": "", "type": "query", "description": "Ending range to return the maintenances which are not completed (date-time is in [RFC3339](https://tools.ietf.org/html/rfc3339) format)." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Gets a list of all the maintenance events for the given compartment.\n" }, { "info": { "name": "GetInstanceMaintenanceEvent", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instanceMaintenanceEvents/:instanceMaintenanceEventId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "instanceMaintenanceEventId", "value": "", "type": "path", "description": "The OCID of the instance maintenance event." } ] }, "docs": "Gets the maintenance event for the given instance.\n" }, { "info": { "name": "UpdateInstanceMaintenanceEvent", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/instanceMaintenanceEvents/:instanceMaintenanceEventId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "instanceMaintenanceEventId", "value": "", "type": "path", "description": "The OCID of the instance maintenance event." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the maintenance event for the given instance.\n" }, { "info": { "name": "ListInstances", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "capacityReservationId", "value": "", "type": "query", "description": "The OCID of the compute capacity reservation." }, { "name": "computeClusterId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\nA [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory\naccess (RDMA) network group.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n" } ] }, "docs": "Lists the instances in the specified compartment and the specified availability domain.\nYou can filter the results by specifying an instance name (the list will include all the identically-named\ninstances in the compartment).\n\n**Note:** To retrieve public and private IP addresses for an instance, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation to get the VNIC ID for the instance, and then call [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID." }, { "info": { "name": "LaunchInstance", "type": "http" }, "http": { "method": "POST", "url": "/20160918/instances/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new instance in the specified compartment and the specified availability domain.\nFor general information about instances, see\n[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).\n\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nFor information about availability domains, see\n[Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a li" }, { "info": { "name": "GetInstance", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Gets information about the specified instance.\n\n**Note:** To retrieve public and private IP addresses for an instance, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation to get the VNIC ID for the instance, and then call [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.\n" }, { "info": { "name": "InstanceAction", "type": "http" }, "http": { "method": "POST", "url": "/20160918/instances/:instanceId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." }, { "name": "action", "value": "", "type": "query", "description": "The action to perform on the instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs one of the following power actions on the specified instance:\n\n- **START** - Powers on the instance.\n\n- **STOP** - Powers off the instance.\n\n- **RESET** - Powers off the instance and then powers it back on.\n\n- **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off.\nIf the applications that run on the instance take more than 15 minutes to shut down, they could b" }, { "info": { "name": "UpdateInstance", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/instances/:instanceId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates certain fields on the specified instance. Fields that are not provided in the\nrequest will not be updated. Avoid entering confidential information.\n\nChanges to metadata fields will be reflected in the instance metadata service (this may take\nup to a minute).\n\nThe OCID of the instance remains the same.\n" }, { "info": { "name": "TerminateInstance", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/instances/:instanceId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." }, { "name": "preserveBootVolume", "value": "", "type": "query", "description": "Specifies whether to delete or preserve the boot volume when terminating an instance.\nWhen set to `true`, the boot volume is preserved. The default value is `false`.\n" }, { "name": "preserveDataVolumesCreatedAtLaunch", "value": "", "type": "query", "description": "Specifies whether to delete or preserve the data volumes created during launch when\nterminating an instance. When set to `true`, the data volumes are preserved. The \ndefault value is `true`.\n" }, { "name": "recycleLevel", "value": "", "type": "query", "description": "This optional parameter overrides recycle level for hosts. The parameter can be used when hosts are associated\nwith a Capacity Reservation.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" } ] }, "docs": "Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached\nwhen the instance terminates.\n\nTo preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`.\nTo delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.\n\nTo preserve data volumes created with the instance, specify `true` or do not specify a value for `PreserveData" }, { "info": { "name": "AcceptShieldedIntegrityPolicy", "type": "http" }, "http": { "method": "POST", "url": "/20160918/instances/:instanceId/actions/acceptShieldedIntegrityPolicy", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Accept the changes to the PCR values in the measured boot report." }, { "info": { "name": "ChangeInstanceCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/instances/:instanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an instance into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance to a different compartment, associated resources such as boot volumes and VNICs\nare not moved.\n" }, { "info": { "name": "GetInstanceDefaultCredentials", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/:instanceId/defaultCredentials", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n" }, { "info": { "name": "ListInstanceDevices", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/:instanceId/devices", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "isAvailable", "value": "", "type": "query", "description": "A filter to return only available devices or only used devices.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only devices that match the given name exactly.\n" }, { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Gets a list of all the devices for given instance. You can optionally filter results by device availability." }, { "info": { "name": "GetWindowsInstanceInitialCredentials", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/:instanceId/initialCredentials", "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Deprecated. Use [GetInstanceDefaultCredentials](#/en/iaas/latest/InstanceCredentials/GetInstanceDefaultCredentials) instead.\n\nGets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n" }, { "info": { "name": "GetInstanceMaintenanceReboot", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/:instanceId/maintenanceReboot", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Gets the maximum possible date that a maintenance reboot can be extended. For more information, see\n[Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm).\n" }, { "info": { "name": "GetMeasuredBootReport", "type": "http" }, "http": { "method": "GET", "url": "/20160918/instances/:instanceId/measuredBootReport", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "instanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance." } ] }, "docs": "Gets the measured boot report for this shielded instance." }, { "info": { "name": "ListShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/shapes", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "imageId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image." }, { "name": "shape", "value": "", "type": "query", "description": "Shape name." } ] }, "docs": "Lists the shapes that can be used to launch an instance within the specified compartment. You can\nfilter the list by compatibility with a specific image.\n" }, { "info": { "name": "ListVnicAttachments", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vnicAttachments/", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "instanceId", "value": "", "type": "query", "description": "The OCID of the instance." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "vnicId", "value": "", "type": "query", "description": "The OCID of the VNIC." } ] }, "docs": "Lists the VNIC attachments in the specified compartment. A VNIC attachment\nresides in the same compartment as the attached instance. The list can be\nfiltered by instance, VNIC, or availability domain.\n" }, { "info": { "name": "AttachVnic", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vnicAttachments/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a secondary VNIC and attaches it to the specified instance.\nFor more information about secondary VNICs, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, { "info": { "name": "GetVnicAttachment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vnicAttachments/:vnicAttachmentId", "params": [ { "name": "vnicAttachmentId", "value": "", "type": "path", "description": "The OCID of the VNIC attachment." } ] }, "docs": "Gets the information for the specified VNIC attachment.\n" }, { "info": { "name": "DetachVnic", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/vnicAttachments/:vnicAttachmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "vnicAttachmentId", "value": "", "type": "path", "description": "The OCID of the VNIC attachment." } ] }, "docs": "Detaches and deletes the specified secondary VNIC.\nThis operation cannot be used on the instance's primary VNIC.\nWhen you terminate an instance, all attached VNICs (primary\nand secondary) are automatically detached and deleted.\n\n**Important:** If the VNIC has a\n[private IP](#/en/iaas/latest/PrivateIp/) that is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\ndeleting the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n" }, { "info": { "name": "ListVolumeAttachments", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeAttachments/", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "instanceId", "value": "", "type": "query", "description": "The OCID of the instance." }, { "name": "volumeId", "value": "", "type": "query", "description": "The OCID of the volume." } ] }, "docs": "Lists the volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, volume OCID, or both.\n\nCurrently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and\n[ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/).\n" }, { "info": { "name": "AttachVolume", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeAttachments/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified storage volume to the specified instance.\n" }, { "info": { "name": "GetVolumeAttachment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeAttachments/:volumeAttachmentId", "params": [ { "name": "volumeAttachmentId", "value": "", "type": "path", "description": "The OCID of the volume attachment." } ] }, "docs": "Gets information about the specified volume attachment." }, { "info": { "name": "UpdateVolumeAttachment", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumeAttachments/:volumeAttachmentId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeAttachmentId", "value": "", "type": "path", "description": "The OCID of the volume attachment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information about the specified volume attachment." }, { "info": { "name": "DetachVolume", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumeAttachments/:volumeAttachmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeAttachmentId", "value": "", "type": "path", "description": "The OCID of the volume attachment." } ] }, "docs": "Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n" } ] } ], "bundled": true }