openapi: 3.2.0 info: description: 'Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](/iaas/Content/Network/Concepts/overview.htm), [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](/iaas/Content/Identity/Reference/corepolicyreference.htm) article. ' license: name: Oracle Corporation title: Core Services Blockstorage API version: '20160918' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Core Services API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml what: the harvested document for Core Services API servers: - url: /20160918 tags: - name: blockstorage paths: /blockVolumeReplicas: get: description: 'Lists the block volume replicas in the specified compartment and availability domain. ' operationId: ListBlockVolumeReplicas parameters: - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BlockVolumeReplica/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BlockVolumeReplica' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBlockVolumeReplicas tags: - blockstorage /blockVolumeReplicas/{blockVolumeReplicaId}: get: description: Gets information for the specified block volume replica. operationId: GetBlockVolumeReplica parameters: - $ref: '#/components/parameters/BlockVolumeReplicaIdPathParam' responses: 200: description: The block volume replica's information has been retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BlockVolumeReplica' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBlockVolumeReplica tags: - blockstorage /bootVolumeBackups: get: description: 'Lists the boot volume backups in the specified compartment. You can filter the results by boot volume. ' operationId: ListBootVolumeBackups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BootVolumeIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterBySourceBootVolumeBackupIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BootVolumeBackup/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BootVolumeBackup' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBootVolumeBackups tags: - blockstorage post: description: 'Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm) When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. ' operationId: CreateBootVolumeBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The boot volume backup is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBootVolumeBackup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBootVolumeBackupDetails' description: Request to create a new backup of given boot volume. required: true /bootVolumeBackups/{bootVolumeBackupId}: delete: description: Deletes a boot volume backup. operationId: DeleteBootVolumeBackup parameters: - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The boot volume backup is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBootVolumeBackup tags: - blockstorage get: description: Gets information for the specified boot volume backup. operationId: GetBootVolumeBackup parameters: - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' responses: 200: description: The boot volume backup was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBootVolumeBackup tags: - blockstorage put: description: 'Updates the display name for the specified boot volume backup. Avoid entering confidential information. ' operationId: UpdateBootVolumeBackup parameters: - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The boot volume backup was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateBootVolumeBackup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBootVolumeBackupDetails' description: Update boot volume backup fields required: true /bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment: post: description: 'Moves a boot volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeBootVolumeBackupCompartment parameters: - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The BootVolume Backup Compartment Details is being changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeBootVolumeBackupCompartment tags: - blockstorage x-related-resource: '#/definitions/BootVolumeBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBootVolumeBackupCompartmentDetails' description: Request to change the compartment of given boot volume backup. required: true /bootVolumeBackups/{bootVolumeBackupId}/actions/copy: post: description: 'Creates a boot volume backup copy in specified region. For general information about volume backups, see [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm) ' operationId: CopyBootVolumeBackup parameters: - $ref: '#/components/parameters/BootVolumeBackupIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The boot volume backup copy is being created in specified region. headers: content-location: description: 'Location of the resource. ' schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Location of the resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBootVolumeBackupCopy tags: - blockstorage x-related-resource: '#/definitions/BootVolumeBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyBootVolumeBackupDetails' description: Request to create a cross-region copy of given boot volume backup. required: true /bootVolumeReplicas: get: description: 'Lists the boot volume replicas in the specified compartment and availability domain. ' operationId: ListBootVolumeReplicas parameters: - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BootVolumeReplica/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BootVolumeReplica' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBootVolumeReplicas tags: - blockstorage /bootVolumeReplicas/{bootVolumeReplicaId}: get: description: Gets information for the specified boot volume replica. operationId: GetBootVolumeReplica parameters: - $ref: '#/components/parameters/BootVolumeReplicaIdPathParam' responses: 200: description: The boot volume replica's information has been retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeReplica' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBootVolumeReplica tags: - blockstorage /bootVolumes: get: description: 'Lists the boot volumes in the specified compartment and availability domain. ' operationId: ListBootVolumes parameters: - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VolumeGroupIdQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BootVolume' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListBootVolumes tags: - blockstorage post: description: 'Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm). You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateBootVolume parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The boot volume is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolume' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateBootVolume tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBootVolumeDetails' description: Request to create a new boot volume. required: true /bootVolumes/{bootVolumeId}: delete: description: 'Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see [Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm). **Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted. ' operationId: DeleteBootVolume parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The boot volume is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBootVolume tags: - blockstorage get: description: Gets information for the specified boot volume. operationId: GetBootVolume parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' responses: 200: description: The boot volume's information has been retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolume' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBootVolume tags: - blockstorage put: description: Updates the specified boot volume's display name, defined tags, and free-form tags. operationId: UpdateBootVolume parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The boot volume was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolume' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateBootVolume tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBootVolumeDetails' description: Update boot volume's display name. required: true /bootVolumes/{bootVolumeId}/actions/changeCompartment: post: description: 'Moves a boot volume into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeBootVolumeCompartment parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The BootVolume Compartment Details is being changed headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeBootVolumeCompartment tags: - blockstorage x-related-resource: '#/definitions/BootVolume' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBootVolumeCompartmentDetails' description: Request to change the compartment of given boot volume. required: true /bootVolumes/{bootVolumeId}/kmsKey: delete: description: 'Removes the specified boot volume''s assigned Vault Service encryption key. ' operationId: DeleteBootVolumeKmsKey parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The boot volume''s assigned Vault service encryption key is being removed and replaced with an Oracle-managed encryption key. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteBootVolumeKmsKey tags: - blockstorage get: description: 'Gets the Vault service encryption key assigned to the specified boot volume. ' operationId: GetBootVolumeKmsKey parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The OCID of the Vault service master encryption key associated with this boot volume. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeKmsKey' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetBootVolumeKmsKey tags: - blockstorage put: description: 'Updates the specified volume with a new Vault service master encryption key. ' operationId: UpdateBootVolumeKmsKey parameters: - $ref: '#/components/parameters/BootVolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The volume is being updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BootVolumeKmsKey' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateBootVolumeKmsKey tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBootVolumeKmsKeyDetails' description: Updates the Vault service master encryption key assigned to the specified boot volume. required: true /volumeBackupPolicies: get: description: 'Lists all the volume backup policies available in the specified compartment. For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). ' operationId: ListVolumeBackupPolicies parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - description: 'The OCID of the compartment. If no compartment is specified, the Oracle defined backup policies are listed. ' in: query name: compartmentId required: false schema: type: string maxLength: 255 minLength: 1 responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VolumeBackupPolicy' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVolumeBackupPolicies tags: - blockstorage post: description: 'Creates a new user defined backup policy. For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). ' operationId: CreateVolumeBackupPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The policy is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackupPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeBackupPolicy tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeBackupPolicyDetails' description: Request to create a new scheduled backup policy. required: true /volumeBackupPolicies/{policyId}: delete: description: "Deletes a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n" operationId: DeleteVolumeBackupPolicy parameters: - $ref: '#/components/parameters/VolumeBackupPolicyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The volume backup policy is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolumeBackupPolicy tags: - blockstorage get: description: Gets information for the specified volume backup policy. operationId: GetVolumeBackupPolicy parameters: - $ref: '#/components/parameters/VolumeBackupPolicyIdPathParam' responses: 200: description: The volume backup policy was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackupPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeBackupPolicy tags: - blockstorage put: description: "Updates a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n" operationId: UpdateVolumeBackupPolicy parameters: - $ref: '#/components/parameters/VolumeBackupPolicyIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The volume backup policy was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackupPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVolumeBackupPolicy tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVolumeBackupPolicyDetails' description: Update volume backup policy fields required: true /volumeBackupPolicyAssignments: get: description: 'Gets the volume backup policy assignment for the specified volume. The `assetId` query parameter is required, and the returned list will contain at most one item, since volume can only have one volume backup policy assigned at a time. ' operationId: GetVolumeBackupPolicyAssetAssignment parameters: - $ref: '#/components/parameters/AssetIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VolumeBackupPolicyAssignment' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeBackupPolicyAssetAssignment tags: - blockstorage post: description: 'Assigns a volume backup policy to the specified volume. Note that a given volume can only have one backup policy assigned to it. If this operation is used for a volume that already has a different backup policy assigned, the prior backup policy will be silently unassigned. ' operationId: CreateVolumeBackupPolicyAssignment responses: 200: description: The volume backup policy has been assigned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackupPolicyAssignment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeBackupPolicyAssignment tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeBackupPolicyAssignmentDetails' description: Request to assign a specified policy to a particular volume. required: true /volumeBackupPolicyAssignments/{policyAssignmentId}: delete: description: Deletes a volume backup policy assignment. operationId: DeleteVolumeBackupPolicyAssignment parameters: - $ref: '#/components/parameters/VolumeBackupPolicyAssignmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The volume backup policy assignment has been deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolumeBackupPolicyAssignment tags: - blockstorage get: description: Gets information for the specified volume backup policy assignment. operationId: GetVolumeBackupPolicyAssignment parameters: - $ref: '#/components/parameters/VolumeBackupPolicyAssignmentIdPathParam' responses: 200: description: The volume backup policy assignment was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackupPolicyAssignment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeBackupPolicyAssignment tags: - blockstorage /volumeBackups: get: description: 'Lists the volume backups in the specified compartment. You can filter the results by volume. ' operationId: ListVolumeBackups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VolumeIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterBySourceVolumeBackupIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VolumeBackup/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VolumeBackup' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVolumeBackups tags: - blockstorage post: description: 'Creates a new backup of the specified volume. For general information about volume backups, see [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm) When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state. ' operationId: CreateVolumeBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The volume backup is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeBackup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeBackupDetails' description: Request to create a new backup of given volume. required: true /volumeBackups/{volumeBackupId}: delete: description: Deletes a volume backup. operationId: DeleteVolumeBackup parameters: - $ref: '#/components/parameters/VolumeBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The volume backup is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolumeBackup tags: - blockstorage get: description: Gets information for the specified volume backup. operationId: GetVolumeBackup parameters: - $ref: '#/components/parameters/VolumeBackupIdPathParam' responses: 200: description: The volume backup was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeBackup tags: - blockstorage put: description: 'Updates the display name for the specified volume backup. Avoid entering confidential information. ' operationId: UpdateVolumeBackup parameters: - $ref: '#/components/parameters/VolumeBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The volume backup was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVolumeBackup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVolumeBackupDetails' description: Update volume backup fields required: true /volumeBackups/{volumeBackupId}/actions/changeCompartment: post: description: 'Moves a volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVolumeBackupCompartment parameters: - $ref: '#/components/parameters/VolumeBackupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Volume Backup Compartment Details is being changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVolumeBackupCompartment tags: - blockstorage x-related-resource: '#/definitions/VolumeBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVolumeBackupCompartmentDetails' description: Request to change the compartment of given volume backup. required: true /volumeBackups/{volumeBackupId}/actions/copy: post: description: 'Creates a volume backup copy in specified region. For general information about volume backups, see [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm) ' operationId: CopyVolumeBackup parameters: - $ref: '#/components/parameters/VolumeBackupIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The volume backup copy is being created in specified region. headers: content-location: description: 'Location of the resource. ' schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Location of the resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeBackupCopy tags: - blockstorage x-related-resource: '#/definitions/VolumeBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyVolumeBackupDetails' description: Request to create a cross-region copy of given backup. required: true /volumeGroupBackups: get: description: 'Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: ListVolumeGroupBackups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VolumeGroupIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VolumeGroupBackup' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVolumeGroupBackups tags: - blockstorage post: description: 'Creates a new backup volume group of the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: CreateVolumeGroupBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The volume group backup is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroupBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeGroupBackup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeGroupBackupDetails' description: Request to create a new backup group of given volume group. required: true /volumeGroupBackups/{volumeGroupBackupId}: delete: description: 'Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: DeleteVolumeGroupBackup parameters: - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The volume group backup is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolumeGroupBackup tags: - blockstorage get: description: Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). operationId: GetVolumeGroupBackup parameters: - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' responses: 200: description: The volume group backup was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroupBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeGroupBackup tags: - blockstorage put: description: Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). operationId: UpdateVolumeGroupBackup parameters: - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The volume group backup was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroupBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVolumeGroupBackup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVolumeGroupBackupDetails' description: Update volume group backup fields required: true /volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment: post: description: 'Moves a volume group backup into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVolumeGroupBackupCompartment parameters: - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The VolumeGroup Backup Compartment Details is being changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVolumeGroupBackupCompartment tags: - blockstorage x-related-resource: '#/definitions/VolumeGroupBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVolumeGroupBackupCompartmentDetails' description: Request to change the compartment of given volume group backup. required: true /volumeGroupBackups/{volumeGroupBackupId}/actions/copy: post: description: 'Creates a volume group backup copy in specified region. For general information about volume group backups, see [Overview of Block Volume Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm). ' operationId: CopyVolumeGroupBackup parameters: - $ref: '#/components/parameters/VolumeGroupBackupIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The volume group backup copy is being created in specified region. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroupBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeGroupBackupCopy tags: - blockstorage x-related-resource: '#/definitions/VolumeGroupBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyVolumeGroupBackupDetails' description: Request to create a cross-region copy of given volume group backup. required: true /volumeGroupReplicas: get: description: 'Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm). ' operationId: ListVolumeGroupReplicas parameters: - $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VolumeGroupReplica/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VolumeGroupReplica' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the volume group replicas in the specified compartment. tags: - blockstorage /volumeGroupReplicas/{volumeGroupReplicaId}: get: description: Gets information for the specified volume group replica. operationId: GetVolumeGroupReplica parameters: - $ref: '#/components/parameters/VolumeGroupReplicaIdPathParam' responses: 200: description: The volume group replica was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroupReplica' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets information for the specified volume group replica. tags: - blockstorage /volumeGroups: get: description: 'Lists the volume groups in the specified compartment and availability domain. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: ListVolumeGroups parameters: - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VolumeGroup/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VolumeGroup' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVolumeGroups tags: - blockstorage post: description: 'Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a *display name* for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: CreateVolumeGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The volume group is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolumeGroup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeGroupDetails' description: Request to create a new volume group. required: true /volumeGroups/{volumeGroupId}: delete: description: 'Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: DeleteVolumeGroup parameters: - $ref: '#/components/parameters/VolumeGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The volume group is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolumeGroup tags: - blockstorage get: description: Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). operationId: GetVolumeGroup parameters: - $ref: '#/components/parameters/VolumeGroupIdPathParam' responses: 200: description: The volume group's information has been retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeGroup tags: - blockstorage put: description: 'Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). ' operationId: UpdateVolumeGroup parameters: - $ref: '#/components/parameters/VolumeGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PreserveVolumeReplicaQueryParam' responses: 200: description: The volume group was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVolumeGroup tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVolumeGroupDetails' description: Update volume group's set of volumes and/or display name required: true /volumeGroups/{volumeGroupId}/actions/changeCompartment: post: description: 'Moves a volume group into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVolumeGroupCompartment parameters: - $ref: '#/components/parameters/VolumeGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The VolumeGroup Compartment Details is being changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVolumeGroupCompartment tags: - blockstorage x-related-resource: '#/definitions/VolumeGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVolumeGroupCompartmentDetails' description: Request to change the compartment of given volume group. required: true /volumes: get: description: 'Lists the volumes in the specified compartment and availability domain. ' operationId: ListVolumes parameters: - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/VolumeGroupIdQueryParam' - $ref: '#/components/parameters/FilterByClusterPlacementGroupIdQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Volume/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Volume' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVolumes tags: - blockstorage post: description: 'Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see [Overview of Block Volume Service](/iaas/Content/Block/Concepts/overview.htm). A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateVolume parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The volume is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Volume' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVolume tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVolumeDetails' description: Request to create a new volume. required: true /volumes/{volumeId}: delete: description: 'Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see [Disconnecting From a Volume](/iaas/Content/Block/Tasks/disconnectingfromavolume.htm). **Warning:** All data on the volume will be permanently lost when the volume is deleted. ' operationId: DeleteVolume parameters: - $ref: '#/components/parameters/VolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The volume is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolume tags: - blockstorage get: description: Gets information for the specified volume. operationId: GetVolume parameters: - $ref: '#/components/parameters/VolumeIdPathParam' responses: 200: description: The volume's information has been retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Volume' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolume tags: - blockstorage put: description: 'Updates the specified volume''s display name. Avoid entering confidential information. ' operationId: UpdateVolume parameters: - $ref: '#/components/parameters/VolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The volume was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Volume' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVolume tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVolumeDetails' description: Update volume's display name. Avoid entering confidential information. required: true /volumes/{volumeId}/actions/changeCompartment: post: description: 'Moves a volume into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVolumeCompartment parameters: - $ref: '#/components/parameters/VolumeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Volume Compartment Details is being changed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVolumeCompartment tags: - blockstorage x-related-resource: '#/definitions/Volume' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVolumeCompartmentDetails' description: Request to change the compartment of given volume. required: true /volumes/{volumeId}/kmsKey: delete: description: 'Removes the specified volume''s assigned Vault service encryption key. ' operationId: DeleteVolumeKmsKey parameters: - $ref: '#/components/parameters/VolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The volume''s assigned Vault service encryption key is being removed and replaced with an Oracle-managed encryption key. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVolumeKmsKey tags: - blockstorage get: description: 'Gets the Vault service encryption key assigned to the specified volume. ' operationId: GetVolumeKmsKey parameters: - $ref: '#/components/parameters/VolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The OCID of the Vault service master encryption key associated with this volume. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeKmsKey' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVolumeKmsKey tags: - blockstorage put: description: 'Updates the specified volume with a new Key Management master encryption key. ' operationId: UpdateVolumeKmsKey parameters: - $ref: '#/components/parameters/VolumeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The volume is being updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VolumeKmsKey' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVolumeKmsKey tags: - blockstorage requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVolumeKmsKeyDetails' description: Updates the Vault service master encryption key assigned to the specified volume. required: true components: parameters: AvailabilityDomainQueryParam: description: 'The name of the availability domain. Example: `Uocm:PHX-AD-1` ' in: query name: availabilityDomain required: false schema: type: string BootVolumeIdPathParam: description: The OCID of the boot volume. in: path name: bootVolumeId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string FilterBySourceBootVolumeBackupIdQueryParam: description: 'A filter to return only resources that originated from the given source boot volume backup. ' in: query name: sourceBootVolumeBackupId required: false schema: type: string maxLength: 255 minLength: 1 VolumeBackupPolicyAssignmentIdPathParam: description: The OCID of the volume backup policy assignment. in: path name: policyAssignmentId required: true schema: type: string SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. ' in: query name: sortOrder required: false x-default-description: The default sort order varies by API. schema: type: string enum: - ASC - DESC default: ASC BootVolumeReplicaIdPathParam: description: The OCID of the boot volume replica. in: path name: bootVolumeReplicaId required: true schema: type: string PreserveVolumeReplicaQueryParam: description: 'Specifies whether to disable or preserve the individual volume replication when removing a volume from the replication enabled volume group. When set to `true`, the individual volume replica is preserved. The default value is `true`. ' in: query name: preserveVolumeReplica required: false schema: type: boolean RequestIdHeader: description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id schema: type: string pattern: '[A-Za-z0-9\-_\.]+' VolumeBackupIdPathParam: description: The OCID of the volume backup. in: path name: volumeBackupId required: true schema: type: string VolumeIdPathParam: description: The OCID of the volume. in: path name: volumeId required: true schema: type: string VolumeIdQueryParam: description: The OCID of the volume. in: query name: volumeId schema: type: string VolumeBackupPolicyIdPathParam: description: The OCID of the volume backup policy. in: path name: policyId required: true schema: type: string SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false x-default-description: The default field to sort by varies by API. schema: type: string enum: - TIMECREATED - DISPLAYNAME VolumeGroupReplicaIdPathParam: description: The OCID of the volume replica group. in: path name: volumeGroupReplicaId required: true schema: type: string RequiredAvailabilityDomainQueryParam: description: 'The name of the availability domain. Example: `Uocm:PHX-AD-1` ' in: query name: availabilityDomain required: true schema: type: string BlockVolumeReplicaIdPathParam: description: The OCID of the block volume replica. in: path name: blockVolumeReplicaId required: true schema: type: string FilterBySourceVolumeBackupIdQueryParam: description: 'A filter to return only resources that originated from the given source volume backup. ' in: query name: sourceVolumeBackupId required: false schema: type: string maxLength: 255 minLength: 1 FilterByDisplayNameQueryParam: description: 'A filter to return only resources that match the given display name exactly. ' in: query name: displayName required: false schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string maxLength: 4096 minLength: 1 BootVolumeBackupIdPathParam: description: The OCID of the boot volume backup. in: path name: bootVolumeBackupId required: true schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 VolumeGroupBackupIdPathParam: description: 'The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. ' in: path name: volumeGroupBackupId required: true schema: type: string AssetIdQueryParam: description: The OCID of an asset (e.g. a volume). in: query name: assetId required: true schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit x-default-description: The default maximum results per page varies by API. schema: type: integer maximum: 100 minimum: 1 BootVolumeIdQueryParam: description: The OCID of the boot volume. in: query name: bootVolumeId schema: type: string VolumeGroupIdPathParam: description: The Oracle Cloud ID (OCID) that uniquely identifies the volume group. in: path name: volumeGroupId required: true schema: type: string FilterByClusterPlacementGroupIdQueryParam: description: 'A filter to return only resources that match the given cluster placement group Id exactly. ' in: query name: clusterPlacementGroupId required: false schema: type: string maxLength: 255 minLength: 1 VolumeGroupIdQueryParam: description: The OCID of the volume group. in: query name: volumeGroupId schema: type: string schemas: UpdateBootVolumeKmsKeyDetails: properties: kmsKeyId: description: 'The OCID of the new Vault service key to assign to protect the specified volume. This key has to be a valid Vault service key, and policies must exist to allow the user and the Block Volume service to access this key. If you specify the same OCID as the previous key''s OCID, the Block Volume service will use it to regenerate a volume encryption key. ' maxLength: 255 minLength: 1 type: string Volume: description: 'A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. For more information, see [Overview of Cloud Volume Storage](/iaas/Content/Block/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: autoTunedVpusPerGB: description: 'The number of Volume Performance Units per GB that this volume is effectively tuned to. ' format: int64 type: integer autotunePolicies: description: The list of autotune policies enabled for this volume. items: $ref: '#/components/schemas/AutotunePolicy' type: array uniqueItems: true availabilityDomain: description: 'The availability domain of the volume. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string blockVolumeReplicas: description: The list of block volume replicas of this volume. items: $ref: '#/components/schemas/BlockVolumeReplicaInfo' type: array clusterPlacementGroupId: description: The clusterPlacementGroup Id of the volume for volume placement. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the volume. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the volume. maxLength: 255 minLength: 1 type: string isAutoTuneEnabled: description: 'Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. ' type: boolean isHydrated: description: 'Specifies whether the cloned volume''s data has finished copying from the source volume or backup. ' type: boolean isReservationsEnabled: description: 'When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see [Persistent Reservations](/iaas/Content/Block/Concepts/persistent-reservations.htm). ' type: boolean kmsKeyId: description: 'The OCID of the Vault service key which is the master encryption key for the volume. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a volume. enum: - PROVISIONING - RESTORING - AVAILABLE - TERMINATING - TERMINATED - FAULTY type: string sizeInGBs: description: The size of the volume in GBs. format: int64 type: integer sizeInMBs: description: 'The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead. ' format: int64 type: integer sourceDetails: $ref: '#/components/schemas/VolumeSourceDetails' timeCreated: description: The date and time the volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string volumeGroupId: description: The OCID of the source volume group. maxLength: 255 minLength: 1 type: string vpusPerGB: description: "The number of volume performance units (VPUs) that will be applied to this volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n * `0`: Represents Lower Cost option.\n\n * `10`: Represents Balanced option.\n\n * `20`: Represents Higher Performance option.\n\n * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB.\n" format: int64 type: integer required: - id - availabilityDomain - displayName - sizeInMBs - compartmentId - timeCreated - lifecycleState Error: properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string messageArguments: additionalProperties: type: string description: 'The values to be substituted into the `originalMessageTemplate`, expressed as a string-to-string map. ' type: object originalMessage: description: A human-readable error string in English. This value might be different from the `message` field. type: string originalMessageTemplate: description: 'The template for the `originalMessage` in ICU message format, but without the values to be substituted. ' type: string required: - code - message VolumeGroupReplicaInfo: description: Information about the volume group replica in the destination availability domain. properties: availabilityDomain: description: 'The availability domain of the boot volume replica replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string volumeGroupReplicaId: description: The volume group replica's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string required: - volumeGroupReplicaId - availabilityDomain - displayName UpdateVolumeBackupPolicyDetails: description: 'Specifies the properties for updating a user defined backup policy. For more information about user defined backup policies, see [User Defined Policies](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies) in [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object destinationRegion: description: 'The paired destination region for copying scheduled backups to. Example: `us-ashburn-1`. Specify `none` to reset the `destinationRegion` parameter. See [Region Pairs](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object schedules: description: 'The collection of schedules for the volume backup policy. See see [Schedules](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules) in [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm) for more information. ' items: $ref: '#/components/schemas/VolumeBackupSchedule' type: array CreateBootVolumeBackupDetails: properties: bootVolumeId: description: The OCID of the boot volume that needs to be backed up. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean kmsKeyId: description: 'The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' type: description: The type of backup to create. If omitted, defaults to incremental. enum: - FULL - INCREMENTAL type: string required: - bootVolumeId BootVolumeReplica: description: 'An asynchronous replica of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see [Overview of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm) To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: availabilityDomain: description: 'The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string bootVolumeId: description: The OCID of the source boot volume. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the boot volume replica. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The boot volume replica's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string imageId: description: 'The image OCID used to create the boot volume the replica is replicated from. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a boot volume replica. enum: - PROVISIONING - AVAILABLE - ACTIVATING - TERMINATING - TERMINATED - FAULTY type: string sizeInGBs: description: 'The size of the source boot volume, in GBs. ' format: int64 maximum: 16384 minimum: 1 type: integer timeCreated: description: 'The date and time the boot volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeLastSynced: description: 'The date and time the boot volume replica was last synced from the source boot volume. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string totalDataTransferredInGBs: description: 'The total size of the data transferred from the source boot volume to the boot volume replica, in GBs. ' format: int64 type: integer volumeGroupReplicaId: description: 'The OCID of the volume group replica. ' maxLength: 255 minLength: 1 type: string required: - id - availabilityDomain - sizeInGBs - displayName - compartmentId - timeCreated - lifecycleState - timeLastSynced - bootVolumeId BlockVolumeReplicaDetails: description: Contains the details for the block volume replica properties: availabilityDomain: description: 'The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string required: - availabilityDomain CreateVolumeGroupBackupDetails: properties: compartmentId: description: 'The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean retentionPeriod: $ref: '#/components/schemas/RetentionDuration' type: description: The type of backup to create. If omitted, defaults to incremental. enum: - FULL - INCREMENTAL type: string volumeGroupId: description: The OCID of the volume group that needs to be backed up. maxLength: 255 minLength: 1 type: string required: - volumeGroupId CreateVolumeDetails: description: 'The details of the volume to create. For CreateVolume operation, this field is required in the request, see [CreateVolume](#/en/iaas/latest/Volume/CreateVolume). ' properties: autotunePolicies: description: The list of autotune policies to be enabled for this volume. items: $ref: '#/components/schemas/AutotunePolicy' type: array uniqueItems: true availabilityDomain: description: 'The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string backupPolicyId: description: 'If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. ' maxLength: 255 minLength: 1 type: string blockVolumeReplicas: description: 'The list of block volume replicas to be enabled for this volume in the specified destination availability domains. ' items: $ref: '#/components/schemas/BlockVolumeReplicaDetails' maxItems: 1 type: array uniqueItems: true clusterPlacementGroupId: description: The clusterPlacementGroup Id of the volume for volume placement. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the volume. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutoTuneEnabled: description: 'Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. ' type: boolean isReservationsEnabled: description: 'When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see [Persistent Reservations](/iaas/Content/Block/Concepts/persistent-reservations.htm). ' type: boolean kmsKeyId: description: 'The OCID of the Vault service key to assign as the master encryption key for the volume. ' maxLength: 255 minLength: 1 type: string sizeInGBs: description: The size of the volume in GBs. format: int64 type: integer sizeInMBs: description: 'The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead. ' format: int64 type: integer sourceDetails: $ref: '#/components/schemas/VolumeSourceDetails' volumeBackupId: description: 'The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume. ' maxLength: 255 minLength: 1 type: string vpusPerGB: description: "The number of volume performance units (VPUs) that will be applied to this volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n * `0`: Represents Lower Cost option.\n\n * `10`: Represents Balanced option.\n\n * `20`: Represents Higher Performance option.\n\n * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.\n" format: int64 type: integer required: - compartmentId BootVolumeKmsKey: description: 'The Vault service master encryption key associated with this volume. ' properties: kmsKeyId: description: 'The OCID of the Vault service key assigned to this volume. If the volume is not using Vault service, then the `kmsKeyId` will be a null string. ' maxLength: 255 minLength: 1 type: string CreateBootVolumeDetails: properties: autotunePolicies: description: The list of autotune policies to be enabled for this volume. items: $ref: '#/components/schemas/AutotunePolicy' type: array uniqueItems: true availabilityDomain: description: 'The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string bootVolumeReplicas: description: 'The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains. ' items: $ref: '#/components/schemas/BootVolumeReplicaDetails' maxItems: 1 type: array uniqueItems: true clusterPlacementGroupId: description: The clusterPlacementGroup Id of the volume for volume placement. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the boot volume. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutoTuneEnabled: description: 'Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. ' type: boolean kmsKeyId: description: 'The OCID of the Vault service key to assign as the master encryption key for the boot volume. ' maxLength: 255 minLength: 1 type: string sizeInGBs: description: The size of the volume in GBs. format: int64 type: integer sourceDetails: $ref: '#/components/schemas/BootVolumeSourceDetails' vpusPerGB: description: "The number of volume performance units (VPUs) that will be applied to this volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n * `10`: Represents the Balanced option.\n\n * `20`: Represents the Higher Performance option.\n\n * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.\n" format: int64 type: integer required: - compartmentId - sourceDetails VolumeGroupSourceDetails: description: Specifies the source for a volume group. discriminator: propertyName: type properties: type: type: string required: - type VolumeKmsKey: description: 'The Vault service master encryption key associated with this volume. ' properties: kmsKeyId: description: 'The OCID of the Vault service key assigned to this volume. If the volume is not using Vault service, then the `kmsKeyId` will be a null string. ' maxLength: 255 minLength: 1 type: string ChangeBootVolumeCompartmentDetails: description: Contains the details for the compartment to move the boot volume to. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the boot volume to. maxLength: 255 minLength: 1 type: string required: - compartmentId VolumeGroup: description: 'Specifies a volume group which is a collection of volumes. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: availabilityDomain: description: The availability domain of the volume group. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the volume group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID for the volume group. maxLength: 255 minLength: 1 type: string isHydrated: description: 'Specifies whether the newly created cloned volume group''s data has finished copying from the source volume group or backup. ' type: boolean lifecycleState: description: The current state of a volume group. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED - FAULTY type: string sizeInGBs: description: The aggregate size of the volume group in GBs. format: int64 type: integer sizeInMBs: description: The aggregate size of the volume group in MBs. format: int64 type: integer sourceDetails: $ref: '#/components/schemas/VolumeGroupSourceDetails' timeCreated: description: The date and time the volume group was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string volumeGroupReplicas: description: The list of volume group replicas of this volume group. items: $ref: '#/components/schemas/VolumeGroupReplicaInfo' type: array volumeIds: description: OCIDs for the volumes in this volume group. items: maxLength: 255 minLength: 1 type: string maxItems: 64 type: array required: - id - volumeIds - availabilityDomain - displayName - sizeInMBs - compartmentId - timeCreated - lifecycleState ChangeBootVolumeBackupCompartmentDetails: description: Contains the details for the compartment to move the boot volume backup to. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the boot volume backup to. maxLength: 255 minLength: 1 type: string required: - compartmentId CopyVolumeBackupDetails: properties: destinationRegion: description: 'The name of the destination region. Example: `us-ashburn-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string kmsKeyId: description: 'The OCID of the Vault service key in the destination region which will be the master encryption key for the copied volume backup. If you do not specify this attribute the volume backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string required: - destinationRegion CopyBootVolumeBackupDetails: properties: destinationRegion: description: 'The name of the destination region. Example: `us-ashburn-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string kmsKeyId: description: 'The OCID of the Vault service key in the destination region which will be the master encryption key for the copied boot volume backup. If you do not specify this attribute the boot volume backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string required: - destinationRegion VolumeBackupSchedule: description: 'Defines the backup frequency and retention period for a volume backup policy. For more information, see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). ' properties: backupType: description: The type of volume backup to create. enum: - FULL - INCREMENTAL type: string dayOfMonth: description: The day of the month to schedule the volume backup. maximum: 31 minimum: 1 type: integer dayOfWeek: description: The day of the week to schedule the volume backup. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string hourOfDay: description: The hour of the day to schedule the volume backup. maximum: 23 minimum: 0 type: integer isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean month: description: The month of the year to schedule the volume backup. enum: - JANUARY - FEBRUARY - MARCH - APRIL - MAY - JUNE - JULY - AUGUST - SEPTEMBER - OCTOBER - NOVEMBER - DECEMBER type: string offsetSeconds: description: 'The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset. ' maximum: 31532400 minimum: 0 multipleOf: 3600 type: integer offsetType: description: 'Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses. `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. `dayOfWeek` is applicable for period `ONE_WEEK`. `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. ''month'' is applicable for period ''ONE_YEAR''. They will be ignored in the requests for inapplicable periods. If value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses. For clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`. ' enum: - STRUCTURED - NUMERIC_SECONDS type: string period: description: The volume backup frequency. enum: - ONE_HOUR - ONE_DAY - ONE_WEEK - ONE_MONTH - ONE_YEAR type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' retentionSeconds: description: How long, in seconds, to keep the volume backups created by this schedule. maximum: 1576800000 minimum: 3600 multipleOf: 3600 type: integer timeZone: default: UTC description: Specifies what time zone is the schedule in enum: - UTC - REGIONAL_DATA_CENTER_TIME type: string required: - period - backupType - retentionSeconds RetentionDuration: description: This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. properties: retentionTimeAmount: description: The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. type: integer retentionTimeUnit: description: The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". enum: - YEARS - DAYS type: string required: - retentionTimeUnit - retentionTimeAmount UpdateVolumeDetails: properties: autotunePolicies: description: The list of autotune policies enabled for this volume. items: $ref: '#/components/schemas/AutotunePolicy' type: array uniqueItems: true blockVolumeReplicas: description: 'The list of block volume replicas that this volume will be updated to have in the specified destination availability domains. ' items: $ref: '#/components/schemas/BlockVolumeReplicaDetails' maxItems: 1 type: array uniqueItems: true definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutoTuneEnabled: description: 'Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. ' type: boolean isReservationsEnabled: description: 'When set to true, enables SCSI Persistent Reservation (SCSI PR) for the volume. For more information, see [Persistent Reservations](/iaas/Content/Block/Concepts/persistent-reservations.htm). ' type: boolean sizeInGBs: description: The size to resize the volume to in GBs. Has to be larger than the current size. format: int64 type: integer vpusPerGB: description: "The number of volume performance units (VPUs) that will be applied to this volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n * `0`: Represents Lower Cost option.\n\n * `10`: Represents Balanced option.\n\n * `20`: Represents Higher Performance option.\n\n * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.\n" format: int64 type: integer BootVolumeSourceDetails: discriminator: propertyName: type properties: type: type: string required: - type BootVolume: description: 'A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see [Overview of Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: autoTunedVpusPerGB: description: 'The number of Volume Performance Units per GB that this boot volume is effectively tuned to. ' format: int64 type: integer autotunePolicies: description: The list of autotune policies enabled for this volume. items: $ref: '#/components/schemas/AutotunePolicy' type: array uniqueItems: true availabilityDomain: description: 'The availability domain of the boot volume. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string bootVolumeReplicas: description: The list of boot volume replicas of this boot volume items: $ref: '#/components/schemas/BootVolumeReplicaInfo' type: array clusterPlacementGroupId: description: The clusterPlacementGroup Id of the volume for volume placement. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the boot volume. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The boot volume's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string imageId: description: The image OCID used to create the boot volume. maxLength: 255 minLength: 1 type: string isAutoTuneEnabled: description: 'Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. ' type: boolean isHydrated: description: 'Specifies whether the boot volume''s data has finished copying from the source boot volume or boot volume backup. ' type: boolean kmsKeyId: description: The OCID of the Vault service master encryption key assigned to the boot volume. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a boot volume. enum: - PROVISIONING - RESTORING - AVAILABLE - TERMINATING - TERMINATED - FAULTY type: string sizeInGBs: description: The size of the boot volume in GBs. format: int64 type: integer sizeInMBs: description: 'The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs. ' format: int64 type: integer sourceDetails: $ref: '#/components/schemas/BootVolumeSourceDetails' timeCreated: description: 'The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string volumeGroupId: description: The OCID of the source volume group. maxLength: 255 minLength: 1 type: string vpusPerGB: description: "The number of volume performance units (VPUs) that will be applied to this boot volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n * `10`: Represents Balanced option.\n\n * `20`: Represents Higher Performance option.\n\n * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.\n" format: int64 type: integer required: - id - availabilityDomain - sizeInMBs - compartmentId - timeCreated - lifecycleState ChangeVolumeGroupCompartmentDetails: description: Contains the details for the compartment to move the volume group to. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume group to. maxLength: 255 minLength: 1 type: string required: - compartmentId BootVolumeBackup: description: 'A point-in-time copy of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm) To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: bootVolumeId: description: The OCID of the boot volume. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the boot volume backup. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string expirationTime: description: 'The date and time the volume backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. ' format: date-time type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the boot volume backup. maxLength: 255 minLength: 1 type: string imageId: description: 'The image OCID used to create the boot volume the backup is taken from. ' maxLength: 255 minLength: 1 type: string isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean kmsKeyId: description: 'The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a boot volume backup. enum: - CREATING - AVAILABLE - TERMINATING - TERMINATED - FAULTY - REQUEST_RECEIVED type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' sizeInGBs: description: 'The size of the boot volume, in GBs. ' format: int64 maximum: 16384 minimum: 1 type: integer sourceBootVolumeBackupId: description: The OCID of the source boot volume backup. maxLength: 255 minLength: 1 type: string sourceType: description: 'Specifies whether the backup was created manually, or via scheduled backup policy. ' enum: - MANUAL - SCHEDULED type: string timeCreated: description: 'The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeRequestReceived: description: 'The date and time the request to create the boot volume backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeRetentionExpiresAt: description: The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. format: date-time type: string type: description: The type of a volume backup. enum: - FULL - INCREMENTAL type: string uniqueSizeInGBs: description: 'The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental. ' format: int64 maximum: 16384 minimum: 0 type: integer volumeGroupBackupId: description: The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - timeCreated - lifecycleState VolumeBackupPolicyAssignment: description: 'Specifies the volume that the volume backup policy is assigned to. For more information about Oracle defined backup policies and custom backup policies, see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). ' properties: assetId: description: The OCID of the volume the policy has been assigned to. maxLength: 255 minLength: 1 type: string id: description: The OCID of the volume backup policy assignment. maxLength: 255 minLength: 1 type: string policyId: description: 'The OCID of the volume backup policy that has been assigned to the volume. ' maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the volume backup policy was assigned to the volume. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - id - policyId - assetId - timeCreated CreateVolumeGroupDetails: properties: availabilityDomain: description: The availability domain of the volume group. maxLength: 255 minLength: 1 type: string backupPolicyId: description: 'If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. ' maxLength: 255 minLength: 1 type: string clusterPlacementGroupId: description: The clusterPlacementGroup Id of the volume group for volume group placement. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the volume group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object sourceDetails: $ref: '#/components/schemas/VolumeGroupSourceDetails' volumeGroupReplicas: description: 'The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains. ' items: $ref: '#/components/schemas/VolumeGroupReplicaDetails' maxItems: 1 type: array uniqueItems: true required: - availabilityDomain - compartmentId - sourceDetails VolumeGroupReplicaDetails: description: Contains the details for the volume group replica. properties: availabilityDomain: description: 'The availability domain of the volume group replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string required: - availabilityDomain VolumeBackup: description: 'A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of Cloud Volume Storage](/iaas/Content/Block/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment that contains the volume backup. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string expirationTime: description: 'The date and time the volume backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. ' format: date-time type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the volume backup. maxLength: 255 minLength: 1 type: string isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean kmsKeyId: description: 'The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a volume backup. enum: - CREATING - AVAILABLE - TERMINATING - TERMINATED - FAULTY - REQUEST_RECEIVED type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' sizeInGBs: description: 'The size of the volume, in GBs. ' format: int64 maximum: 16384 minimum: 1 type: integer sizeInMBs: description: 'The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs. ' format: int64 maximum: 16777216 minimum: 1024 type: integer sourceType: description: 'Specifies whether the backup was created manually, or via scheduled backup policy. ' enum: - MANUAL - SCHEDULED type: string sourceVolumeBackupId: description: The OCID of the source volume backup. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeRequestReceived: description: 'The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339. ' format: date-time type: string timeRetentionExpiresAt: description: The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. format: date-time type: string type: description: The type of a volume backup. enum: - FULL - INCREMENTAL type: string uniqueSizeInGBs: description: 'The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental. ' format: int64 maximum: 16384 minimum: 0 type: integer uniqueSizeInMbs: description: 'The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs. ' format: int64 maximum: 16777216 minimum: 0 type: integer volumeGroupBackupId: description: The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group. maxLength: 255 minLength: 1 type: string volumeId: description: The OCID of the volume. maxLength: 255 minLength: 1 type: string required: - id - type - displayName - compartmentId - timeCreated - lifecycleState UpdateVolumeGroupDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object volumeGroupReplicas: description: 'The list of volume group replicas that this volume group will be updated to have in the specified destination availability domains. ' items: $ref: '#/components/schemas/VolumeGroupReplicaDetails' maxItems: 1 type: array uniqueItems: true volumeIds: description: OCIDs for the volumes in this volume group. items: maxLength: 255 minLength: 1 type: string maxItems: 64 type: array VolumeBackupPolicy: description: 'A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment that contains the volume backup. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object destinationRegion: description: 'The paired destination region for copying scheduled backups to. Example `us-ashburn-1`. See [Region Pairs](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the volume backup policy. maxLength: 255 minLength: 1 type: string schedules: description: The collection of schedules that this policy will apply. items: $ref: '#/components/schemas/VolumeBackupSchedule' type: array timeCreated: description: 'The date and time the volume backup policy was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - id - displayName - schedules - timeCreated UpdateBootVolumeDetails: properties: autotunePolicies: description: The list of autotune policies to be enabled for this volume. items: $ref: '#/components/schemas/AutotunePolicy' type: array uniqueItems: true bootVolumeReplicas: description: 'The list of boot volume replicas that this boot volume will be updated to have in the specified destination availability domains. ' items: $ref: '#/components/schemas/BootVolumeReplicaDetails' maxItems: 1 type: array uniqueItems: true definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isAutoTuneEnabled: description: 'Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. ' type: boolean sizeInGBs: description: The size to resize the volume to in GBs. Has to be larger than the current size. format: int64 type: integer vpusPerGB: description: "The number of volume performance units (VPUs) that will be applied to this volume per GB,\nrepresenting the Block Volume service's elastic performance options.\nSee [Block Volume Performance Levels](/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n\n * `10`: Represents Balanced option.\n\n * `20`: Represents Higher Performance option.\n\n * `30`-`120`: Represents the Ultra High Performance option.\n\nFor performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.\n" format: int64 type: integer VolumeSourceDetails: description: 'Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup. ' discriminator: propertyName: type properties: type: type: string required: - type CopyVolumeGroupBackupDetails: properties: destinationRegion: description: 'The name of the destination region. Example: `us-ashburn-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string kmsKeyId: description: 'The OCID of the Vault service key in the destination region which will be the master encryption key for the copied volume group backup. If you do not specify this attribute the volume group backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string required: - destinationRegion ChangeVolumeBackupCompartmentDetails: description: Contains the details for the compartment to move the volume backup to. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume backup to. maxLength: 255 minLength: 1 type: string required: - compartmentId UpdateBootVolumeBackupDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean kmsKeyId: description: 'The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' MemberReplica: description: OCIDs for the volume replicas in this volume group replica. properties: volumeReplicaId: description: The volume replica ID. maxLength: 255 minLength: 1 type: string required: - volumeReplicaId BootVolumeReplicaInfo: description: Information about the boot volume replica in the destination availability domain. properties: availabilityDomain: description: 'The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string bootVolumeReplicaId: description: The boot volume replica's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string required: - bootVolumeReplicaId - availabilityDomain - displayName VolumeGroupBackup: description: 'A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment that contains the volume group backup. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string expirationTime: description: 'The date and time the volume group backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. ' format: date-time type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the volume group backup. maxLength: 255 minLength: 1 type: string isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean lifecycleState: description: The current state of a volume group backup. enum: - CREATING - COMMITTED - AVAILABLE - TERMINATING - TERMINATED - FAULTY - REQUEST_RECEIVED type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' sizeInGBs: description: 'The aggregate size of the volume group backup, in GBs. ' format: int64 type: integer sizeInMBs: description: 'The aggregate size of the volume group backup, in MBs. ' format: int64 type: integer sourceType: description: 'Specifies whether the volume group backup was created manually, or via scheduled backup policy. ' enum: - MANUAL - SCHEDULED type: string sourceVolumeGroupBackupId: description: The OCID of the source volume group backup. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeRequestReceived: description: 'The date and time the request to create the volume group backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeRetentionExpiresAt: description: The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. format: date-time type: string type: description: The type of backup. enum: - FULL - INCREMENTAL type: string uniqueSizeInGbs: description: 'The aggregate size used by the volume group backup, in GBs. It is typically smaller than sizeInGBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental. ' format: int64 type: integer uniqueSizeInMbs: description: 'The aggregate size used by the volume group backup, in MBs. It is typically smaller than sizeInMBs, depending on the spaceconsumed on the volume group and whether the volume backup is full or incremental. ' format: int64 type: integer volumeBackupIds: description: OCIDs for the volume backups in this volume group backup. items: maxLength: 255 minLength: 1 type: string maxItems: 64 type: array volumeGroupId: description: The OCID of the source volume group. maxLength: 255 minLength: 1 type: string required: - id - volumeBackupIds - displayName - compartmentId - timeCreated - type - lifecycleState UpdateVolumeKmsKeyDetails: properties: kmsKeyId: description: 'The OCID of the new Vault service key to assign to protect the specified volume. This key has to be a valid Vault service key, and policies must exist to allow the user and the Block Volume service to access this key. If you specify the same OCID as the previous key''s OCID, the Block Volume service will use it to regenerate a volume encryption key. ' maxLength: 255 minLength: 1 type: string ChangeVolumeCompartmentDetails: description: Contains the details for the compartment to move the volume to. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume to. maxLength: 255 minLength: 1 type: string required: - compartmentId UpdateVolumeBackupDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean kmsKeyId: description: 'The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' BlockVolumeReplicaInfo: description: Information about the block volume replica in the destination availability domain. properties: availabilityDomain: description: 'The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string blockVolumeReplicaId: description: The block volume replica's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string required: - blockVolumeReplicaId - availabilityDomain - displayName BlockVolumeReplica: description: 'An asynchronous replica of a block volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm) To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: availabilityDomain: description: 'The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string blockVolumeId: description: The OCID of the source block volume. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the block volume replica. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The block volume replica's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a block volume replica. enum: - PROVISIONING - AVAILABLE - ACTIVATING - TERMINATING - TERMINATED - FAULTY type: string sizeInGBs: description: 'The size of the source block volume, in GBs. ' format: int64 maximum: 16384 minimum: 1 type: integer timeCreated: description: 'The date and time the block volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeLastSynced: description: 'The date and time the block volume replica was last synced from the source block volume. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string totalDataTransferredInGBs: description: 'The total size of the data transferred from the source block volume to the block volume replica, in GBs. ' format: int64 type: integer volumeGroupReplicaId: description: 'The OCID of the volume group replica. ' maxLength: 255 minLength: 1 type: string required: - id - availabilityDomain - sizeInGBs - compartmentId - displayName - timeCreated - lifecycleState - timeLastSynced - blockVolumeId BootVolumeReplicaDetails: description: Contains the details for the boot volume replica properties: availabilityDomain: description: 'The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string required: - availabilityDomain ChangeVolumeGroupBackupCompartmentDetails: description: Contains the details for the compartment to move the volume group backup to. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the volume group backup to. maxLength: 255 minLength: 1 type: string required: - compartmentId VolumeGroupReplica: description: 'An asynchronous replica of a volume group that can then be used to create a new volume group or recover a volume group. For more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: availabilityDomain: description: The availability domain of the volume group replica. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment that contains the volume group replica. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID for the volume group replica. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of a volume group. enum: - PROVISIONING - AVAILABLE - ACTIVATING - TERMINATING - TERMINATED - FAULTY type: string memberReplicas: description: Volume replicas within this volume group replica. items: $ref: '#/components/schemas/MemberReplica' maxItems: 64 type: array sizeInGBs: description: The aggregate size of the volume group replica in GBs. format: int64 type: integer timeCreated: description: The date and time the volume group replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeLastSynced: description: 'The date and time the volume group replica was last synced from the source volume group. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string volumeGroupId: description: The OCID of the source volume group. maxLength: 255 minLength: 1 type: string required: - id - memberReplicas - availabilityDomain - displayName - sizeInGBs - compartmentId - timeCreated - lifecycleState - volumeGroupId - timeLastSynced CreateVolumeBackupPolicyAssignmentDetails: properties: assetId: description: The OCID of the volume to assign the policy to. maxLength: 255 minLength: 1 type: string policyId: description: The OCID of the volume backup policy to assign to the volume. maxLength: 255 minLength: 1 type: string required: - policyId - assetId CreateVolumeBackupDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean kmsKeyId: description: 'The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ' maxLength: 255 minLength: 1 type: string retentionPeriod: $ref: '#/components/schemas/RetentionDuration' type: description: The type of backup to create. If omitted, defaults to INCREMENTAL. enum: - FULL - INCREMENTAL type: string volumeId: description: The OCID of the volume that needs to be backed up. maxLength: 255 minLength: 1 type: string required: - volumeId UpdateVolumeGroupBackupDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isIndefiniteRetentionEnabled: description: feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. type: boolean isPreventDeletionEnabled: description: Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. type: boolean isRetentionLockEnabled: description: feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. type: boolean retentionPeriod: $ref: '#/components/schemas/RetentionDuration' AutotunePolicy: description: An autotune policy automatically tunes the volume's performace based on the type of the policy. discriminator: propertyName: autotuneType properties: autotuneType: description: This specifies the type of autotunes supported by OCI. enum: - DETACHED_VOLUME - PERFORMANCE_BASED type: string required: - autotuneType CreateVolumeBackupPolicyDetails: description: 'Specifies the properties for creating user defined backup policy. For more information about user defined backup policies, see [User Defined Policies](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies) in [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object destinationRegion: description: 'The paired destination region for copying scheduled backups to. Example: `us-ashburn-1`. See [Region Pairs](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object schedules: description: 'The collection of schedules for the volume backup policy. See see [Schedules](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#schedules) in [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm) for more information. ' items: $ref: '#/components/schemas/VolumeBackupSchedule' type: array required: - compartmentId responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: data-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the resource. ' type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string lifecycle-state: description: The IpInventory API current state. enum: - IN_PROGRESS - DONE type: string location: description: 'Location of the resource. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' type: integer opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' type: string x-platform-config-properties: amdNumaNodesPerSocketNps1: default: NPS1 description: 'The number of NUMA nodes per socket (NPS). ' enum: - NPS0 - NPS1 - NPS2 - NPS4 - NPS6 type: string amdNumaNodesPerSocketNps4: default: NPS4 description: 'The number of NUMA nodes per socket (NPS). ' enum: - NPS0 - NPS1 - NPS2 - NPS4 - NPS6 type: string areVirtualInstructionsEnabledFalse: default: false description: 'Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. ' type: boolean areVirtualInstructionsEnabledTrue: default: true description: 'Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. ' type: boolean configMap: additionalProperties: type: string description: 'Instance Platform Configuration Configuration Map for flexible setting input. ' type: object definedTagsFilter: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). ' type: object imageVolumeIndex: description: 'When launching from a Compute Image, it is possible for more than one volume to be defined in the Image definition. If the relative index of one of these volumes is provided in this field, then the provided createVolumeDetails descriptor will be utilized to modify the default creation/attachment parameters for this volume rather than the defaults. If this field is provided, then CreateVolumeDetails must be specified. ' minimum: 1 type: integer x-default-description: 'null' intelNumaNodesPerSocketNps1: default: NPS1 description: 'The number of NUMA nodes per socket (NPS). ' enum: - NPS1 - NPS2 type: string isAccessControlServiceEnabledFalse: default: false description: 'Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through. ' type: boolean isAccessControlServiceEnabledTrue: default: true description: 'Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through. ' type: boolean isInputOutputMemoryManagementUnitEnabledFalse: default: false description: 'Whether the input-output memory management unit is enabled. ' type: boolean isInputOutputMemoryManagementUnitEnabledTrue: default: true description: 'Whether the input-output memory management unit is enabled. ' type: boolean isSymmetricMultiThreadingEnabledTrue: default: true description: 'Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads. ' type: boolean percentageOfCoresEnabled: default: 100 description: 'The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores. If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled. ' maximum: 100 minimum: 25 multipleOf: 25 type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object recycleLevel: description: 'Preferred recycle level for hosts associated with the reservation config. * `SKIP_RECYCLE` - Skips host wipe. * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. ' enum: - SKIP_RECYCLE - FULL_RECYCLE type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` ' type: object x-network-ip-lifetime-default-properties: lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string x-network-ip-lifetime-properties: lifetime: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string x-network-ip-state-properties: ipState: description: 'State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. ' enum: - ASSIGNED - AVAILABLE type: string x-obmcs-client-circuit-breaker-table: dummy: enabled: false x-obmcs-client-retries-table: blockStorage: enabled: true c3: enabled: true pnp: enabled: true x-route-table-id-properties: routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string