ListVolumes
get
/20160918/volumes
List the volumes in the specified compartment and availability domain.
Request
Supported Media Types
- application/json
Query Parameters
-
availabilityDomain: string
The availability domain of the pod shape.
-
compartmentId: string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment.Default Value:none
-
displayName: string
Minimum Length:
1
Maximum Length:255
A filter to return only resources that match the entire display name given. -
isRegional: boolean
Whether to list regional volumes or not. When set to true, only regional volumes are listed. Otherwise AD local volumes are returned. The default value is false.Default Value:
false
-
lifecycleState: string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
-
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
-
sortBy: string
The optional field to sort the results by.Default Value:
NAME
Allowed Values:[ "ID", "NAME", "TIME_CREATED" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Allowed Values:
[ "ASC", "DESC" ]
-
volumeGroupId: string
The OCID of the volume group.
Response
Supported Media Types
- application/json
200 Response
The list is being retrieved.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Volume
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.
Nested 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.
-
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment that contains the volume. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined 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: additionalPropertiesFree-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. -
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. -
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: additionalPropertiesSystem 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 [RFC3339](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 volume -
volumeType:
string
Allowed Values:
[ "FULL", "THIN_CLONE" ]
The type of volume -
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.
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.
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.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
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
Nested Schema : systemTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
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.
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.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace.
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.
Key-value pair representing a defined tag key and value, scoped to a namespace.
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. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload