Method: organizations.locations.customers.workloads.list

Lists customer workloads for a given customer org id

HTTP request

GET https://cloudcontrolspartner.googleapis.com/v1alpha/{parent=organizations/*/locations/*/customers/*}/workloads

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

Query parameters

Parameters
pageSize

integer

The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.
pageToken

string

A page token, received from a previous workloads.list call. Provide this to retrieve the subsequent page.
filter

string

Optional. Filtering results.
orderBy

string

Optional. Hint for how to order the results.

Request body

The request body must be empty.

Response body

Response message for list customer workloads requests.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "workloads": [
    {
      object (Workload)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
workloads[]

object (Workload)

List of customer workloads
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • cloudcontrolspartner.workloads.list

For more information, see the IAM documentation.