{ "opencollection": "1.0.0", "info": { "name": "Core Services Blockstorage API", "version": "20160918" }, "items": [ { "info": { "name": "blockstorage", "type": "folder" }, "items": [ { "info": { "name": "ListBlockVolumeReplicas", "type": "http" }, "http": { "method": "GET", "url": "/20160918/blockVolumeReplicas", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the block volume replicas in the specified compartment and availability domain.\n" }, { "info": { "name": "GetBlockVolumeReplica", "type": "http" }, "http": { "method": "GET", "url": "/20160918/blockVolumeReplicas/:blockVolumeReplicaId", "params": [ { "name": "blockVolumeReplicaId", "value": "", "type": "path", "description": "The OCID of the block volume replica." } ] }, "docs": "Gets information for the specified block volume replica." }, { "info": { "name": "ListBootVolumeBackups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumeBackups", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "bootVolumeId", "value": "", "type": "query", "description": "The OCID of the boot volume." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sourceBootVolumeBackupId", "value": "", "type": "query", "description": "A filter to return only resources that originated from the given source boot volume backup.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is\ncase-insensitive.\n" } ] }, "docs": "Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.\n" }, { "info": { "name": "CreateBootVolumeBackup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/bootVolumeBackups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n" }, { "info": { "name": "GetBootVolumeBackup", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumeBackups/:bootVolumeBackupId", "params": [ { "name": "bootVolumeBackupId", "value": "", "type": "path", "description": "The OCID of the boot volume backup." } ] }, "docs": "Gets information for the specified boot volume backup." }, { "info": { "name": "UpdateBootVolumeBackup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/bootVolumeBackups/:bootVolumeBackupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeBackupId", "value": "", "type": "path", "description": "The OCID of the boot volume backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the display name for the specified boot volume backup.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteBootVolumeBackup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/bootVolumeBackups/:bootVolumeBackupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeBackupId", "value": "", "type": "path", "description": "The OCID of the boot volume backup." } ] }, "docs": "Deletes a boot volume backup." }, { "info": { "name": "ChangeBootVolumeBackupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/bootVolumeBackups/:bootVolumeBackupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bootVolumeBackupId", "value": "", "type": "path", "description": "The OCID of the boot volume backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a boot volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "CreateBootVolumeBackupCopy", "type": "http" }, "http": { "method": "POST", "url": "/20160918/bootVolumeBackups/:bootVolumeBackupId/actions/copy", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bootVolumeBackupId", "value": "", "type": "path", "description": "The OCID of the boot volume backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a boot volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n" }, { "info": { "name": "ListBootVolumeReplicas", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumeReplicas", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the boot volume replicas in the specified compartment and availability domain.\n" }, { "info": { "name": "GetBootVolumeReplica", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumeReplicas/:bootVolumeReplicaId", "params": [ { "name": "bootVolumeReplicaId", "value": "", "type": "path", "description": "The OCID of the boot volume replica." } ] }, "docs": "Gets information for the specified boot volume replica." }, { "info": { "name": "ListBootVolumes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumes", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "volumeGroupId", "value": "", "type": "query", "description": "The OCID of the volume group." } ] }, "docs": "Lists the boot volumes in the specified compartment and availability domain.\n" }, { "info": { "name": "CreateBootVolume", "type": "http" }, "http": { "method": "POST", "url": "/20160918/bootVolumes", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.\nFor general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm).\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n" }, { "info": { "name": "GetBootVolume", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumes/:bootVolumeId", "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ] }, "docs": "Gets information for the specified boot volume." }, { "info": { "name": "UpdateBootVolume", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/bootVolumes/:bootVolumeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified boot volume's display name, defined tags, and free-form tags." }, { "info": { "name": "DeleteBootVolume", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/bootVolumes/:bootVolumeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ] }, "docs": "Deletes the specified boot volume. The volume cannot have an active connection to an instance.\nTo disconnect the boot volume from a connected instance, see\n[Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm).\n**Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted.\n" }, { "info": { "name": "ChangeBootVolumeCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/bootVolumes/:bootVolumeId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a boot volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "GetBootVolumeKmsKey", "type": "http" }, "http": { "method": "GET", "url": "/20160918/bootVolumes/:bootVolumeId/kmsKey", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ] }, "docs": "Gets the Vault service encryption key assigned to the specified boot volume.\n" }, { "info": { "name": "UpdateBootVolumeKmsKey", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/bootVolumes/:bootVolumeId/kmsKey", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified volume with a new Vault service master encryption key.\n" }, { "info": { "name": "DeleteBootVolumeKmsKey", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/bootVolumes/:bootVolumeId/kmsKey", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "bootVolumeId", "value": "", "type": "path", "description": "The OCID of the boot volume." } ] }, "docs": "Removes the specified boot volume's assigned Vault Service encryption key.\n" }, { "info": { "name": "ListVolumeBackupPolicies", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeBackupPolicies", "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\nIf no compartment is specified, the Oracle defined backup policies are listed.\n" } ] }, "docs": "Lists all the volume backup policies available in the specified compartment.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n" }, { "info": { "name": "CreateVolumeBackupPolicy", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeBackupPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user defined backup policy.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n" }, { "info": { "name": "GetVolumeBackupPolicy", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeBackupPolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the volume backup policy." } ] }, "docs": "Gets information for the specified volume backup policy." }, { "info": { "name": "UpdateVolumeBackupPolicy", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumeBackupPolicies/:policyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the volume backup policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "DeleteVolumeBackupPolicy", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumeBackupPolicies/:policyId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the volume backup policy." } ] }, "docs": "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" }, { "info": { "name": "GetVolumeBackupPolicyAssetAssignment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeBackupPolicyAssignments", "params": [ { "name": "assetId", "value": "", "type": "query", "description": "The OCID of an asset (e.g. a volume)." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Gets the volume backup policy assignment for the specified volume. The\n`assetId` query parameter is required, and the returned list will contain at most\none item, since volume can only have one volume backup policy assigned at a time.\n" }, { "info": { "name": "CreateVolumeBackupPolicyAssignment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeBackupPolicyAssignments", "body": { "type": "json", "data": "{}" } }, "docs": "Assigns a volume backup policy to the specified volume. Note that a given volume can\nonly have one backup policy assigned to it. If this operation is used for a volume that already\nhas a different backup policy assigned, the prior backup policy will be silently unassigned.\n" }, { "info": { "name": "GetVolumeBackupPolicyAssignment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeBackupPolicyAssignments/:policyAssignmentId", "params": [ { "name": "policyAssignmentId", "value": "", "type": "path", "description": "The OCID of the volume backup policy assignment." } ] }, "docs": "Gets information for the specified volume backup policy assignment." }, { "info": { "name": "DeleteVolumeBackupPolicyAssignment", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumeBackupPolicyAssignments/:policyAssignmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "policyAssignmentId", "value": "", "type": "path", "description": "The OCID of the volume backup policy assignment." } ] }, "docs": "Deletes a volume backup policy assignment." }, { "info": { "name": "ListVolumeBackups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeBackups", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "volumeId", "value": "", "type": "query", "description": "The OCID of the volume." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sourceVolumeBackupId", "value": "", "type": "query", "description": "A filter to return only resources that originated from the given source volume backup.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n" } ] }, "docs": "Lists the volume backups in the specified compartment. You can filter the results by volume.\n" }, { "info": { "name": "CreateVolumeBackup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeBackups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new backup of the specified volume. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n" }, { "info": { "name": "GetVolumeBackup", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeBackups/:volumeBackupId", "params": [ { "name": "volumeBackupId", "value": "", "type": "path", "description": "The OCID of the volume backup." } ] }, "docs": "Gets information for the specified volume backup." }, { "info": { "name": "UpdateVolumeBackup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumeBackups/:volumeBackupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeBackupId", "value": "", "type": "path", "description": "The OCID of the volume backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the display name for the specified volume backup.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteVolumeBackup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumeBackups/:volumeBackupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeBackupId", "value": "", "type": "path", "description": "The OCID of the volume backup." } ] }, "docs": "Deletes a volume backup." }, { "info": { "name": "ChangeVolumeBackupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeBackups/:volumeBackupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "volumeBackupId", "value": "", "type": "path", "description": "The OCID of the volume backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "CreateVolumeBackupCopy", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeBackups/:volumeBackupId/actions/copy", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "volumeBackupId", "value": "", "type": "path", "description": "The OCID of the volume backup." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n" }, { "info": { "name": "ListVolumeGroupBackups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeGroupBackups", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "volumeGroupId", "value": "", "type": "query", "description": "The OCID of the volume group." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the volume group backups in the specified compartment. You can filter the results by volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n" }, { "info": { "name": "CreateVolumeGroupBackup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeGroupBackups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new backup volume group of the specified volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n" }, { "info": { "name": "GetVolumeGroupBackup", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeGroupBackups/:volumeGroupBackupId", "params": [ { "name": "volumeGroupBackupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n" } ] }, "docs": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)." }, { "info": { "name": "UpdateVolumeGroupBackup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumeGroupBackups/:volumeGroupBackupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeGroupBackupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)." }, { "info": { "name": "DeleteVolumeGroupBackup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumeGroupBackups/:volumeGroupBackupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeGroupBackupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n" } ] }, "docs": "Deletes a volume group backup. This operation deletes all the backups in\nthe volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n" }, { "info": { "name": "ChangeVolumeGroupBackupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeGroupBackups/:volumeGroupBackupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "volumeGroupBackupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a volume group backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "CreateVolumeGroupBackupCopy", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeGroupBackups/:volumeGroupBackupId/actions/copy", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "volumeGroupBackupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a volume group backup copy in specified region. For general information about volume group backups,\nsee [Overview of Block Volume Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm).\n" }, { "info": { "name": "Lists the volume group replicas in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeGroupReplicas", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the volume group replicas in the specified compartment. You can filter the results by volume group.\nFor more information, see [Volume Group Replication](/iaas/Content/Block/Concepts/volumegroupreplication.htm).\n" }, { "info": { "name": "Gets information for the specified volume group replica.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeGroupReplicas/:volumeGroupReplicaId", "params": [ { "name": "volumeGroupReplicaId", "value": "", "type": "path", "description": "The OCID of the volume replica group." } ] }, "docs": "Gets information for the specified volume group replica." }, { "info": { "name": "ListVolumeGroups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeGroups", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the volume groups in the specified compartment and availability domain.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n" }, { "info": { "name": "CreateVolumeGroup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeGroups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new volume group in the specified compartment.\nA volume group is a collection of volumes and may be created from a list of volumes, cloning an existing\nvolume group, or by restoring a volume group backup.\nYou may optionally specify a *display name* for the volume group, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volu" }, { "info": { "name": "GetVolumeGroup", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumeGroups/:volumeGroupId", "params": [ { "name": "volumeGroupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group." } ] }, "docs": "Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)." }, { "info": { "name": "UpdateVolumeGroup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumeGroups/:volumeGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeGroupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group." }, { "name": "preserveVolumeReplica", "value": "", "type": "query", "description": "Specifies whether to disable or preserve the individual volume replication when removing a volume from the\nreplication enabled volume group. When set to `true`, the individual volume replica is preserved. The default\nvalue is `true`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the set of volumes in a volume group along with the display name. Use this operation\nto add or remove volumes in a volume group. Specify the full list of volume IDs to include in the\nvolume group. If the volume ID is not specified in the call, it will be removed from the volume group.\nAvoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n" }, { "info": { "name": "DeleteVolumeGroup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumeGroups/:volumeGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeGroupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group." } ] }, "docs": "Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n" }, { "info": { "name": "ChangeVolumeGroupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumeGroups/:volumeGroupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "volumeGroupId", "value": "", "type": "path", "description": "The Oracle Cloud ID (OCID) that uniquely identifies the volume group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a volume group into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListVolumes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumes", "params": [ { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "volumeGroupId", "value": "", "type": "query", "description": "The OCID of the volume group." }, { "name": "clusterPlacementGroupId", "value": "", "type": "query", "description": "A filter to return only resources that match the given cluster placement group Id exactly.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n" } ] }, "docs": "Lists the volumes in the specified compartment and availability domain.\n" }, { "info": { "name": "CreateVolume", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumes", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from\n50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB).\nFor general information about block volumes, see\n[Overview of Block Volume Service](/iaas/Content/Block/Concepts/overview.htm).\n\nA volume and instance can be in separate compartments but must be in the same availability domain.\nFor information about access control and compartments, see\n[Ov" }, { "info": { "name": "GetVolume", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumes/:volumeId", "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ] }, "docs": "Gets information for the specified volume." }, { "info": { "name": "UpdateVolume", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumes/:volumeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified volume's display name.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteVolume", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumes/:volumeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ] }, "docs": "Deletes the specified volume. The volume cannot have an active connection to an instance.\nTo disconnect the volume from a connected instance, see\n[Disconnecting From a Volume](/iaas/Content/Block/Tasks/disconnectingfromavolume.htm).\n**Warning:** All data on the volume will be permanently lost when the volume is deleted.\n" }, { "info": { "name": "ChangeVolumeCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/volumes/:volumeId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "GetVolumeKmsKey", "type": "http" }, "http": { "method": "GET", "url": "/20160918/volumes/:volumeId/kmsKey", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ] }, "docs": "Gets the Vault service encryption key assigned to the specified volume.\n" }, { "info": { "name": "UpdateVolumeKmsKey", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/volumes/:volumeId/kmsKey", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified volume with a new Key Management master encryption key.\n" }, { "info": { "name": "DeleteVolumeKmsKey", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/volumes/:volumeId/kmsKey", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "volumeId", "value": "", "type": "path", "description": "The OCID of the volume." } ] }, "docs": "Removes the specified volume's assigned Vault service encryption key.\n" } ] } ], "bundled": true }