- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
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 |
Required. Parent Resource to list workloads from. Must be of the form Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Page size. |
pageToken |
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 |
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 ( |
Fields | |
---|---|
workloads[] |
List of Workloads under a given parent. |
nextPageToken |
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.