Jump to

• Request
• Response

Create a Volume

post

/20160918/volumes

Create a new volume in the specified compartment. The default block volume size is 1024 GB. You can specify a size of 50 to 32768 (50 GB to 32 TB). A volume and instance can be in separate compartments.

You may optionally specify a display name for the volume. The display name does not need to be unique, and you can change it. Avoid entering confidential information.

Synchronous Write Bias and Secondary Cache properties can be set by using defined tags. These values can be changed with UpdateVolume. Specify the OraclePCA tag namespace.

To set a value for the Synchronous Write Bias, specify logBias for the tag key, with a value of either LATENCY or THROUGHPUT. If this value is not set, the value LATENCY is used.

To set a value for the Secondary Cache, specify secondaryCache for the tag key with a value of ALL, METADATA, or NONE. If this value is not set, the value ALL is used.

Request

Supported Media Types

• application/json

Header Parameters

• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  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).

Body ()

Request to create a new volume.

Root Schema : CreateVolumeDetails

Type: object

The details of the volume to create. For the CreateVolume operation, this field is required in the request.

Show Source

• autotunePolicies: array autotunePolicies
  Unique Items Required: true

  The list of autotune policies to be enabled for this volume.
• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the volume, which is AD-1. This parameter is not needed to clone a volume.
• backupPolicyId: string
  Minimum Length: 1

  Maximum Length: 255

  If provided, specifies the OCID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.
• blockVolumeReplicas: array blockVolumeReplicas
  Maximum Number of Items: 1

  Unique Items Required: true

  The list of block volume replicas to be enabled for this volume in the specified destination availability domains.
• buildingHint: string
  Minimum Length: 1

  Maximum Length: 255

  The buildingHint for volume creation. This is an internal parameter passed by compute for best effort collocation.
• clusterPlacementGroupId: string
  Minimum Length: 1

  Maximum Length: 255

  The clusterPlacementGroup ID of the volume for volume placement.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the volume.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  . Each tag is a simple key-value pair with no predefined name, type, or namespace. The volume block size can be set by using the PCA_blocksize free-form tag. The default block size is 8192 bytes. To specify a different block size, specify a value in bytes for the PCA_blocksize tag. Supported values are a power of 2 between 512 bytes and 1 megabyte. The block size cannot be modified once the volume has been created.
• instanceId: string
  Minimum Length: 1

  Maximum Length: 255

  The identifier of the instance that the volume will be associated with.
• ioAlignmentSizeInBytes: integer(int32)
  Minimum Value: 512

  Maximum Value: 32768

  Multiple Of: 512

  The size (in Bytes) of the blocks for this block volume, between 512B to 32KB. Allowed values: * `512` : 512 Bytes * `1024` : 1 KB * `2048` : 2 KB * `4096` : 4 KB * `8192` : 8 KB * `16384`: 16 KB * `32768`: 32 KB
• isAutoTuneEnabled: boolean
  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.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Key Management key to assign as the master encryption key for the volume.
• meteringMode: string
  Indicates whether the volume is to be billed with provisioned metering or pay-per-usage metering. The default behavior is to use provisioned metering.
• siteGroupId: string
  Minimum Length: 1

  Maximum Length: 255

  The siteGroup ID of the volume. This is an internal parameter. If clusterPlacementGroup is specified by external customer this field will be ignored.
• sizeInGBs: integer(int64)
  The size of the volume in GBs.
• sizeInMBs: integer(int64)
  The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.
• sourceDetails: object VolumeSourceDetails
  Discriminator: type

  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 or a disk image in Object Storage. 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.
• volumeBackupId: string
  Minimum Length: 1

  Maximum Length: 255

  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.
• volumeScope: string
  This is an optional field. This value indicates whether the volume is AD-local or Regional. Oracle Private Cloud Appliance has one region, named pca_name.domain (for example, mypca.example.com), and one availability domain, named AD-1.
• volumeType: string
  The flag indicating the given source volumes will be used for producing a thin clone or full clone.
• vpusPerGB: integer(int64)
  The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values: 10 - Balanced option, 20 - Higher Performance option. For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
• xrcKmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Vault service key, which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys.

{
    "description":"The details of the volume to create. For the CreateVolume operation, this field is required in the request.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the volume, which is AD-1. This parameter is not needed to clone a volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "backupPolicyId":{
            "description":"If provided, specifies the OCID 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"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "freeformTags":{
            "description":"                                                      . Each tag is a simple key-value pair with no predefined name, type, or namespace. The volume block size can be set by using the PCA_blocksize free-form tag. The default block size is 8192 bytes. To specify a different block size, specify a value in bytes for the PCA_blocksize tag. Supported values are a power of 2 between 512 bytes and 1 megabyte. The block size cannot be modified once the volume has been created.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "kmsKeyId":{
            "description":"The OCID of the Key Management key to assign as the master encryption key 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, representing the Block Volume service's elastic performance options. Allowed values: 10 - Balanced option, 20 - Higher Performance option. For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.",
            "format":"int64",
            "type":"integer"
        },
        "ioAlignmentSizeInBytes":{
            "description":"The size (in Bytes) of the blocks for this block volume, between 512B to 32KB.  Allowed values:        * `512`  : 512 Bytes       * `1024` : 1 KB       * `2048` : 2 KB       * `4096` : 4 KB       * `8192` : 8 KB       * `16384`: 16 KB       * `32768`: 32 KB ",
            "type":"integer",
            "format":"int32",
            "minimum":512,
            "maximum":32768,
            "multipleOf":512
        },
        "clusterPlacementGroupId":{
            "description":"The clusterPlacementGroup ID of the volume for volume placement.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "siteGroupId":{
            "description":"The siteGroup ID of the volume. This is an internal parameter. If clusterPlacementGroup is specified by external customer this field will be ignored. ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "buildingHint":{
            "description":"The buildingHint for volume creation.  This is an internal parameter passed by compute for best effort collocation. ",
            "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":"#/definitions/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"
        },
        "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"
        },
        "blockVolumeReplicas":{
            "description":"The list of block volume replicas to be enabled for this volume in the specified destination availability domains.",
            "items":{
                "$ref":"#/definitions/BlockVolumeReplicaDetails"
            },
            "type":"array",
            "uniqueItems":true,
            "maxItems":1
        },
        "volumeType":{
            "description":"The flag indicating the given source volumes will be used for producing a thin clone or full clone.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Volume/volumeType"
        },
        "volumeScope":{
            "description":"This is an optional field. This value indicates whether the volume is AD-local or Regional. Oracle Private Cloud Appliance has one region, named pca_name.domain (for example, mypca.example.com), and one availability domain, named AD-1.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Volume/volumeScope"
        },
        "meteringMode":{
            "description":"Indicates whether the volume is to be billed with provisioned metering or pay-per-usage metering. The default behavior is to use provisioned metering. ",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Volume/meteringMode"
        },
        "instanceId":{
            "description":"The identifier of the instance that the volume will be associated with.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "autotunePolicies":{
            "description":"The list of autotune policies to be enabled for this volume.",
            "items":{
                "$ref":"#/definitions/AutotunePolicy"
            },
            "type":"array",
            "uniqueItems":true
        },
        "xrcKmsKeyId":{
            "description":"The OCID of the Vault service key, which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys.",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "compartmentId"
    ],
    "type":"object"
}

Nested Schema : autotunePolicies

Type: array

Unique Items Required: true

The list of autotune policies to be enabled for this volume.

Show Source

• Array of: object AutotunePolicy
  Discriminator: autotuneType

  An autotune policy automatically tunes the volume's performace based on the type of the policy.

{
    "description":"The list of autotune policies to be enabled for this volume.",
    "items":{
        "$ref":"#/definitions/AutotunePolicy"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : blockVolumeReplicas

Type: array

Maximum Number of Items: 1

Unique Items Required: true

The list of block volume replicas to be enabled for this volume in the specified destination availability domains.

Show Source

• Array of: object BlockVolumeReplicaDetails
  Contains the details for the block volume replica

{
    "description":"The list of block volume replicas to be enabled for this volume in the specified destination availability domains.",
    "items":{
        "$ref":"#/definitions/BlockVolumeReplicaDetails"
    },
    "type":"array",
    "uniqueItems":true,
    "maxItems":1
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"                                                      . Each tag is a simple key-value pair with no predefined name, type, or namespace. The volume block size can be set by using the PCA_blocksize free-form tag. The default block size is 8192 bytes. To specify a different block size, specify a value in bytes for the PCA_blocksize tag. Supported values are a power of 2 between 512 bytes and 1 megabyte. The block size cannot be modified once the volume has been created.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

. Each tag is a simple key-value pair with no predefined name, type, or namespace. The volume block size can be set by using the PCA_blocksize free-form tag. The default block size is 8192 bytes. To specify a different block size, specify a value in bytes for the PCA_blocksize tag. Supported values are a power of 2 between 512 bytes and 1 megabyte. The block size cannot be modified once the volume has been created.

Nested Schema : VolumeSourceDetails

Type: object

Discriminator: type

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 or a disk image in Object Storage. 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.

Show Source

• type(required): string

{
    "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 or a disk image in Object Storage. 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":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : AutotunePolicy

Type: object

Discriminator: autotuneType

An autotune policy automatically tunes the volume's performace based on the type of the policy.

Show Source

• autotuneType(required): string
  Allowed Values: [ "DETACHED_VOLUME", "PERFORMANCE_BASED" ]

  This specifies the type of autotunes supported by OCI.

{
    "description":"An autotune policy automatically tunes the volume's performace based on the type of the policy.",
    "discriminator":"autotuneType",
    "properties":{
        "autotuneType":{
            "description":"This specifies the type of autotunes supported by OCI.",
            "type":"string",
            "enum":[
                "DETACHED_VOLUME",
                "PERFORMANCE_BASED"
            ]
        }
    },
    "required":[
        "autotuneType"
    ],
    "type":"object"
}

Nested Schema : BlockVolumeReplicaDetails

Type: object

Contains the details for the block volume replica

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the block volume replica. Example: AD-1
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• xrrKmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys.

{
    "description":"Contains the details for the block volume replica",
    "properties":{
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain of the block volume replica. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "xrrKmsKeyId":{
            "description":"The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys.",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "availabilityDomain"
    ],
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The volume is being created.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Volume

Type: object

A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. Avoid entering confidential information when you supply string values using the API.

Show Source

• autoTunedVpusPerGB: integer(int64)
  The number of Volume Performance Units per GB that this volume is effectively tuned to.
• autotunePolicies: array autotunePolicies
  Unique Items Required: true

  The list of autotune policies enabled for this volume.
• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the volume. Example: AD-1
• blockVolumeReplicas: array blockVolumeReplicas
  The list of block volume replicas of this volume.
• clusterPlacementGroupId: string
  Minimum Length: 1

  Maximum Length: 255

  The clusterPlacementGroup ID of the volume for volume placement.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the volume.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the volume.
• ioAlignmentSizeInBytes: integer(int32)
  Minimum Value: 512

  Maximum Value: 32768

  Multiple Of: 512

  The size (in Bytes) of the blocks for this block volume, between 512B to 32KB.
• isAutoTuneEnabled: boolean
  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.
• isHydrated: boolean
  Specifies whether the cloned volume's data has finished copying from the source volume or backup.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Key Management key which is the master encryption key for the volume.
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "RESTORING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY" ]

  The current state of a volume.
• meteringMode: string
  Default Value: PROVISIONED

  Allowed Values: [ "PROVISIONED", "PAY_PER_USAGE" ]

  The metering mode of the volume
• sizeInGBs: integer(int64)
  The size of the volume in GBs.
• sizeInMBs(required): integer(int64)
  The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
• sourceDetails: object VolumeSourceDetails
  Discriminator: type

  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 or a disk image in Object Storage. 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.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this resource. Each key is predefined and scoped to a namespace.
• timeCreated(required): string(date-time)
  The date and time the volume was created. Format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
• volumeGroupId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the source volume group.
• volumeScope: string
  Default Value: AD_LOCAL

  Allowed Values: [ "REGIONAL", "AD_LOCAL" ]

  The scope of the volume
• volumeType: string
  Allowed Values: [ "FULL", "THIN_CLONE" ]

  An optional field to create/promote thin clones. When it is null, regular volumes are created. A thin clone promotion to full clone (an independent volume) occurs when FULL is used in update API A thin clone is created by specifying THIN_CLONE in create request.
• vpusPerGB: integer(int64)
  The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 0 - Lower Cost option. 10 - Balanced option. 20 - Higher Performance option.

{
    "description":"A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. Avoid entering confidential information when you supply string values using the API.",
    "x-obmcs-splat":{
        "resourceKind":"volumes",
        "adLocality":"ad-local",
        "getOperationId":"GetVolume",
        "listResourcesOperationId":"ListVolumes",
        "ocidEntityType":"volume",
        "activeLifecycleStates":[
            "AVAILABLE"
        ],
        "deletedLifecycleStates":[
            "TERMINATED",
            "FAULTY",
            "TERMINATING"
        ],
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"Volume",
            "scope":"customer",
            "rvnFromHeader":true
        }
    },
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the volume. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "id":{
            "description":"The OCID of the volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "isHydrated":{
            "description":"Specifies whether the cloned volume's data has finished copying from the source volume or backup.",
            "type":"boolean"
        },
        "kmsKeyId":{
            "description":"The OCID of the Key Management 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"
        },
        "vpusPerGB":{
            "description":"The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 0 - Lower Cost option. 10 - Balanced option. 20 - Higher Performance option.",
            "format":"int64",
            "type":"integer"
        },
        "ioAlignmentSizeInBytes":{
            "description":"The size (in Bytes) of the blocks for this block volume, between 512B to 32KB.",
            "type":"integer",
            "format":"int32",
            "minimum":512,
            "maximum":32768,
            "multipleOf":512
        },
        "clusterPlacementGroupId":{
            "description":"The clusterPlacementGroup ID of the volume for volume placement.",
            "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. This field is deprecated. Use sizeInGBs instead.",
            "format":"int64",
            "type":"integer"
        },
        "sourceDetails":{
            "$ref":"#/definitions/VolumeSourceDetails"
        },
        "timeCreated":{
            "description":"The date and time the volume was created. Format defined by [RFC 3339](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"
        },
        "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"
        },
        "autoTunedVpusPerGB":{
            "description":"The number of Volume Performance Units per GB that this volume is effectively tuned to.",
            "format":"int64",
            "type":"integer"
        },
        "blockVolumeReplicas":{
            "description":"The list of block volume replicas of this volume.",
            "items":{
                "$ref":"#/definitions/BlockVolumeReplicaInfo"
            },
            "type":"array"
        },
        "volumeType":{
            "description":"An optional field to create/promote thin clones. When it is null, regular volumes are created. A thin clone promotion to full clone (an independent volume) occurs when FULL is used in update API A thin clone is created by specifying THIN_CLONE in create request. ",
            "enum":[
                "FULL",
                "THIN_CLONE"
            ],
            "type":"string"
        },
        "volumeScope":{
            "description":"The scope of the volume",
            "enum":[
                "REGIONAL",
                "AD_LOCAL"
            ],
            "type":"string",
            "default":"AD_LOCAL"
        },
        "meteringMode":{
            "description":"The metering mode of the volume",
            "enum":[
                "PROVISIONED",
                "PAY_PER_USAGE"
            ],
            "type":"string",
            "default":"PROVISIONED"
        },
        "autotunePolicies":{
            "description":"The list of autotune policies enabled for this volume.",
            "items":{
                "$ref":"#/definitions/AutotunePolicy"
            },
            "type":"array",
            "uniqueItems":true
        }
    },
    "required":[
        "id",
        "displayName",
        "sizeInMBs",
        "compartmentId",
        "timeCreated",
        "lifecycleState"
    ],
    "type":"object"
}

Nested Schema : autotunePolicies

Type: array

Unique Items Required: true

The list of autotune policies enabled for this volume.

Show Source

• Array of: object AutotunePolicy
  Discriminator: autotuneType

  An autotune policy automatically tunes the volume's performace based on the type of the policy.

{
    "description":"The list of autotune policies enabled for this volume.",
    "items":{
        "$ref":"#/definitions/AutotunePolicy"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : blockVolumeReplicas

Type: array

The list of block volume replicas of this volume.

Show Source

• Array of: object BlockVolumeReplicaInfo
  Information about the block volume replica in the destination availability domain.

{
    "description":"The list of block volume replicas of this volume.",
    "items":{
        "$ref":"#/definitions/BlockVolumeReplicaInfo"
    },
    "type":"array"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : VolumeSourceDetails

Type: object

Discriminator: type

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 or a disk image in Object Storage. 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.

Show Source

• type(required): string

{
    "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 or a disk image in Object Storage. 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":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : AutotunePolicy

Type: object

Discriminator: autotuneType

An autotune policy automatically tunes the volume's performace based on the type of the policy.

Show Source

• autotuneType(required): string
  Allowed Values: [ "DETACHED_VOLUME", "PERFORMANCE_BASED" ]

  This specifies the type of autotunes supported by OCI.

{
    "description":"An autotune policy automatically tunes the volume's performace based on the type of the policy.",
    "discriminator":"autotuneType",
    "properties":{
        "autotuneType":{
            "description":"This specifies the type of autotunes supported by OCI.",
            "type":"string",
            "enum":[
                "DETACHED_VOLUME",
                "PERFORMANCE_BASED"
            ]
        }
    },
    "required":[
        "autotuneType"
    ],
    "type":"object"
}

Nested Schema : BlockVolumeReplicaInfo

Type: object

Information about the block volume replica in the destination availability domain.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the block volume replica. Example: AD-1
• blockVolumeReplicaId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The block volume replica's OCID.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Vault service key to assign as the master encryption key for the block volume replica.

{
    "description":"Information about the block volume replica in the destination availability domain.",
    "properties":{
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "blockVolumeReplicaId":{
            "description":"The block volume replica's OCID.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain of the block volume replica. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "kmsKeyId":{
            "description":"The OCID of the Vault service key to assign as the master encryption key for the block volume replica.",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "blockVolumeReplicaId",
        "availabilityDomain",
        "displayName"
    ],
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top