2026-10-26
▼ ▲ vmwareengine.projects.locations.capacityAllocations.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/capacityAllocations
Parameter Order : parent
HTTP Method : GET
Description : Lists `CapacityAllocation` resources in a given project and location.
Path : v1/{+parent}/capacityAllocations
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListCapacityAllocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCapacityAllocations` must match the call that provided the page token.
filter
Description : Optional. A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string or a number. The comparison operator must be `=`, `!=`, `>`, `>=`, `<`, or `<=`. The has operator `:` is also supported. Supported fields include `name`, `display_name` (or `placement_group`), `machine_family`, `allocated_capacity_count`, `consumed_capacity_count`, and `connected_placement_group` (using `=`). For example, if you are filtering a list of capacity allocations, you can exclude the ones named `example-capacity-allocation` by specifying `name != "example-capacity-allocation"`. You can also filter on other fields, such as machine family (`"ve1"`, `"ve2"`, or `"ve3"`) or connected placement group: ``` machine_family = "ve1" connected_placement_group = "example-placement-group" ``` To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (machine_family = "ve1") (allocated_capacity_count > 10) ``` By default, each expression is an `AND` expression. However, you can include `AND`, `OR`, and `NOT` expressions explicitly. For example: ``` ((machine_family = "ve1") AND (allocated_capacity_count > 10)) OR (consumed_capacity_count > 0) ```
Type : string
Location : query
orderBy
Location : query
Type : string
Description : Optional. Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
pageSize
Description : Optional. The maximum number of capacity allocations to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
Format : int32
Type : integer
Location : query
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The resource name of the location to query for capacity allocations. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a`
Location : path