Method: organizations.locations.workloads.violations.list

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format organizations/{org_id}/locations/{location}/workloads/-

HTTP request

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

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The Workload name. Format organizations/{org_id}/locations/{location}/workloads/{workload}.

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

  • assuredworkloads.violations.list

Query parameters

Parameters
interval

object (TimeWindow)

Optional. Specifies the time window for retrieving active Violations. When specified, retrieves Violations that were active between startTime and endTime.
pageSize

integer

Optional. Page size.
pageToken

string

Optional. Page token returned from previous request.
filter

string

Optional. A custom filter for filtering by the Violations properties.

Request body

The request body must be empty.

Response body

Response of violations.list endpoint.

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

JSON representation 
{
  "violations": [
    {
      object (Violation)
    }
  ],
  "nextPageToken": string
}
Fields
violations[]

object (Violation)

List of Violations under a Workload.
nextPageToken

string

The next page token. Returns 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.violations.list

For more information, see the IAM documentation.

TimeWindow

Interval defining a time window.

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

The start of the time window.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

The end of the time window.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".