Jump to

• Request
• Response

List Volume Groups

get

/20160918/volumeGroups

List the volume groups 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(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• 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: 0
• sortBy: string
  The optional field to sort the results by.

  Allowed Values: [ "TIMECREATED", "NAME" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]

Back to Top

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. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• 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 : schema

Type: array

Show Source

• Array of: object VolumeGroup
  Specifies a volume group, which is a collection of volumes. Avoid entering confidential information when you supply string values using the API.

{
    "items":{
        "$ref":"#/definitions/VolumeGroup"
    },
    "type":"array"
}

Nested 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: 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 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 [RFC 3339](https://tools.ietf.org/html/rfc3339).
• volumeGroupReplicas: array volumeGroupReplicas
  The list of volume group replicas of this volume group.
• volumeGroupScope: string
  Default Value: AD_LOCAL

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

  The scope of the volume group
• volumeIds(required): array volumeIds
  Maximum Number of Items: 64

  OCIDs for the volumes in this volume group.

{
    "description":"Specifies a volume group, which is a collection of volumes. Avoid entering confidential information when you supply string values using the API.",
    "x-obmcs-splat":{
        "resourceKind":"volume-groups",
        "adLocality":"ad-local",
        "getOperationId":"GetVolumeGroup",
        "ocidEntityType":"volumegroup",
        "activeLifecycleStates":[
            "AVAILABLE"
        ],
        "deletedLifecycleStates":[
            "TERMINATED",
            "FAULTY"
        ],
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"VolumeGroup",
            "scope":"customer"
        }
    },
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the volume group.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the volume group.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "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"
            }
        },
        "id":{
            "description":"The OCID for the volume group.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of a volume group.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED",
                "FAULTY",
                "UPDATE_PENDING"
            ],
            "type":"string"
        },
        "sizeInMBs":{
            "description":"The aggregate size of the volume group in MBs.",
            "format":"int64",
            "type":"integer"
        },
        "sizeInGBs":{
            "description":"The aggregate size of the volume group in GBs.",
            "format":"int64",
            "type":"integer"
        },
        "sourceDetails":{
            "$ref":"#/definitions/VolumeGroupSourceDetails"
        },
        "timeCreated":{
            "description":"The date and time the volume group was created. Format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).",
            "format":"date-time",
            "type":"string"
        },
        "volumeIds":{
            "description":"OCIDs for the volumes in this volume group.",
            "items":{
                "maxLength":255,
                "minLength":1,
                "type":"string"
            },
            "maxItems":64,
            "type":"array"
        },
        "isHydrated":{
            "description":"Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.",
            "type":"boolean"
        },
        "volumeGroupReplicas":{
            "description":"The list of volume group replicas of this volume group.",
            "items":{
                "$ref":"#/definitions/VolumeGroupReplicaInfo"
            },
            "type":"array"
        },
        "volumeGroupScope":{
            "description":"The scope of the volume group",
            "enum":[
                "REGIONAL",
                "AD_LOCAL"
            ],
            "type":"string",
            "default":"AD_LOCAL"
        }
    },
    "required":[
        "id",
        "volumeIds",
        "availabilityDomain",
        "displayName",
        "sizeInMBs",
        "compartmentId",
        "timeCreated",
        "lifecycleState"
    ],
    "type":"object"
}

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 : VolumeGroupSourceDetails

Type: object

Discriminator: type

Specifies the source for a volume group.

Show Source

• type(required): string

{
    "description":"Specifies the source for a volume group.",
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

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.

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

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

{
    "description":"OCIDs for the volumes in this volume group.",
    "items":{
        "maxLength":255,
        "minLength":1,
        "type":"string"
    },
    "maxItems":64,
    "type":"array"
}

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 : 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.
• 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.
• volumeGroupReplicaId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The volume group replica's OCID.

{
    "description":"Information about the volume group 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"
        },
        "volumeGroupReplicaId":{
            "description":"The volume group replica's OCID.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain of the boot volume replica 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":[
        "volumeGroupReplicaId",
        "availabilityDomain",
        "displayName"
    ],
    "type":"object"
}

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"
}

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