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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-23 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of workloads within a specified application using a \u003ccode\u003eGET\u003c/code\u003e request to the provided URL, which follows gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter, defining the application's fully qualified name, and supports optional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e for result customization.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the successful response contains a JSON representation, which lists the workloads, a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and an \u003ccode\u003eunreachable\u003c/code\u003e field for any locations that could not be reached.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this endpoint requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003eapphub.workloads.list\u003c/code\u003e IAM permission on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.applications.workloads.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListWorkloadsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nLists Workloads in an Application.\n\n### HTTP request\n\n`GET https://apphub.googleapis.com/v1/{parent=projects/*/locations/*/applications/*}/workloads`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for workloads.list.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `apphub.workloads.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
