UpdateVolumeGroup
put
/20160918/volumeGroups/{volume_group_id}
Update the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume OCIDs to include in the volume group. If a volume OCID is not specified in the call, that volume will be removed from the volume group. Avoid entering confidential information.
Request
Supported Media Types
- application/json
Path Parameters
-
volumeGroupId(required): string
The OCID that uniquely identifies the volume group.
Query Parameters
-
preserveVolumeReplica: boolean
Whether to disable or preserve the individual volume replication when removing a volume from the replication enabled volume group. When set to true, the individual volume replica is preserved. The default value is true.
Header Parameters
-
if-match: string
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
Update volume group's set of volumes and/or display name
Root Schema : UpdateVolumeGroupDetails
Type:
Show Source
object
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined 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: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
volumeGroupReplicas:
array volumeGroupReplicas
Maximum Number of Items:
1
Unique Items Required:true
The list of volume group replicas that this volume group will be updated to have in the specified destination availability domains. -
volumeIds:
array volumeIds
Maximum Number of Items:
64
OCIDs for the volumes in this volume group.
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 : volumeGroupReplicas
Type:
array
Maximum Number of Items:
1
Unique Items Required:
true
The list of volume group replicas that this volume group will be updated to have in the specified destination availability domains.
Show Source
-
Array of:
object VolumeGroupReplicaDetails
Contains the details for the volume group replica.
Nested Schema : volumeIds
Type:
array
Maximum Number of Items:
64
OCIDs for the volumes in this volume group.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:255
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 : VolumeGroupReplicaDetails
Type:
object
Contains the details for the volume group replica.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the volume group 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.
Response
Supported Media Types
- application/json
200 Response
The volume group was updated.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
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 : VolumeGroup
Type:
object
Specifies a volume group, which is a collection of volumes. Avoid entering confidential information when you supply string values using the API.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the volume group. -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment that contains the volume group. -
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 for the volume group. -
isHydrated:
boolean
Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
-
lifecycleState(required):
string
Allowed Values:
[ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", "UPDATE_PENDING" ]
The current state of a volume group. -
sizeInGBs:
integer(int64)
The aggregate size of the volume group in GBs.
-
sizeInMBs(required):
integer(int64)
The aggregate size of the volume group in MBs.
-
sourceDetails:
object VolumeGroupSourceDetails
Discriminator:
type
Specifies the source for a volume group. -
timeCreated(required):
string(date-time)
The date and time the volume group was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
-
volumeGroupReplicas:
array volumeGroupReplicas
The list of volume group replicas of this volume group.
-
volumeIds(required):
array volumeIds
Maximum Number of Items:
64
OCIDs for the volumes in this volume group.
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 : VolumeGroupSourceDetails
Type:
object
Discriminator:
type
Specifies the source for a volume group.
Show Source
Nested Schema : volumeGroupReplicas
Type:
array
The list of volume group replicas of this volume group.
Show Source
-
Array of:
object VolumeGroupReplicaInfo
Information about the volume group replica in the destination availability domain.
Nested Schema : volumeIds
Type:
array
Maximum Number of Items:
64
OCIDs for the volumes in this volume group.
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:255
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 : VolumeGroupReplicaInfo
Type:
object
Information about the volume group replica in the destination availability domain.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the boot volume replica replica. Example: AD-1 -
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. -
volumeGroupReplicaId(required):
string
Minimum Length:
1
Maximum Length:255
The volume group replica's OCID.
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
412 Response
Precondition Failed
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