ListVolumes

GET {{baseUrl}}/volumes?compartmentId={{compartment_ocid}}&limit=801&sortBy=TIMECREATED&sortOrder=DESC

Lists the volumes in the specified compartment and availability domain.

Request Params

Example: Uocm:PHX-AD-1 | | compartmentId | string | | (Required) The OCID of the compartment. | | limit | number | | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: 50 | | page | string | | For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination. | | displayName | string | | A filter to return only resources that match the given display name exactly. | | sortBy | string | | The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. | | sortOrder | string | | The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. | | volumeGroupId | string | | The OCID of the volume group. | | lifecycleState | string | | A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. |

HEADERS

RESPONSES

status: OK

[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"availabilityDomain":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sizeInMBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"autoTunedVpusPerGB":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"blockVolumeReplicas":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isAutoTuneEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isHydrated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"kmsKeyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sizeInGBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sourceDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"volumeGroupId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vpusPerGB":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"availabilityDomain":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sizeInMBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"autoTunedVpusPerGB":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"blockVolumeReplicas":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isAutoTuneEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isHydrated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"kmsKeyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sizeInGBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sourceDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"volumeGroupId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vpusPerGB":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]