Method: organizations.locations.workloads.list

Lists Assured Workloads under a CRM Node.

HTTP request

GET https://{endpoint}/v1/{parent=organizations/*/locations/*}/workloads

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.

Authorization requires the following IAM permission on the specified resource parent:

  • assuredworkloads.workload.list

Query parameters

Parameters
pageSize

integer

Page size.
pageToken

string

Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.
filter

string

A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.

Request body

The request body must be empty.

Response body

Response of workloads.list endpoint.

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

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

object (Workload)

List of Workloads under a given parent.
nextPageToken

string

The next page token. Return empty if reached the last page.

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:

  • assuredworkloads.workload.list

For more information, see the IAM documentation.