Method: projects.locations.applications.workloads.list

Lists Workloads in an Application.

HTTP request

GET https://apphub.googleapis.com/v1/{parent=projects/*/locations/*/applications/*}/workloads

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Fully qualified name of the parent Application to list Workloads for. Expected format: projects/{project}/locations/{location}/applications/{application}.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken

string

Optional. A token identifying a page of results the server should return.

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 for workloads.list.

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 Workloads.

nextPageToken

string

A token identifying a page of results the server should return.

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:

  • apphub.workloads.list

For more information, see the IAM documentation.