Method: projects.locations.evaluations.executions.results.list

Lists the result of a single evaluation.

HTTP request

GET https://workloadmanager.googleapis.com/v1/{parent=projects/*/locations/*/evaluations/*/executions/*}/results

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The execution results. Format: {parent}/evaluations/*/executions/*/results

Query parameters

Parameters
pageSize

integer

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

string

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

string

Filtering results

Request body

The request body must be empty.

Response body

Message for response of list execution results

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

JSON representation 
{
  "executionResults": [
    {
      object (ExecutionResult)
    }
  ],
  "nextPageToken": string
}
Fields
executionResults[]

object (ExecutionResult)

The versions from the specified publisher.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

ExecutionResult

Message describing the result of an execution

JSON representation 
{
  "violationMessage": string,
  "severity": string,
  "rule": string,
  "documentationUrl": string,
  "resource": {
    object (Resource)
  },
  "violationDetails": {
    object (ViolationDetails)
  },
  "commands": [
    {
      object (Command)
    }
  ],
  "type": enum (Type)
}
Fields
violationMessage

string

The violation message of an execution.
severity

string

The severity of violation.
rule

string

The rule that is violated in an evaluation.
documentationUrl

string

The URL for the documentation of the rule.
resource

object (Resource)

The resource that violates the rule.
violationDetails

object (ViolationDetails)

The details of violation in an evaluation result.
commands[]

object (Command)

The commands to remediate the violation.
type

enum (Type)

Execution result type of the scanned resource

Resource

Message represent resource in execution result

JSON representation 
{
  "type": string,
  "name": string,
  "serviceAccount": string
}
Fields
type

string

The type of resource.
name

string

The name of the resource.
serviceAccount

string

The service account associated with the resource.

ViolationDetails

Message describing the violation in an evaluation result.

JSON representation 
{
  "asset": string,
  "serviceAccount": string,
  "observed": {
    string: string,
    ...
  },
  "ruleOutput": [
    {
      object (RuleOutput)
    }
  ]
}
Fields
asset

string

The name of the asset.
serviceAccount

string

The service account associated with the resource.
observed

map (key: string, value: string)

Details of the violation.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
ruleOutput[]

object (RuleOutput)

Output only. The rule output of the violation.

RuleOutput

The rule output of the violation.

JSON representation 
{
  "details": {
    string: string,
    ...
  },
  "message": string
}
Fields
details

map (key: string, value: string)

Output only. Violation details generated by rule.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
message

string

Output only. The message generated by rule.

Command

  • Command specifies the type of command to execute.
JSON representation 
{

  // Union field command_type can be only one of the following:
  "agentCommand": {
    object (AgentCommand)
  },
  "shellCommand": {
    object (ShellCommand)
  }
  // End of list of possible types for union field command_type.
}
Fields
Union field command_type. The type of command. command_type can be only one of the following:
agentCommand

object (AgentCommand)

AgentCommand specifies a one-time executable program for the agent to run.
shellCommand

object (ShellCommand)

ShellCommand is invoked via the agent's command line executor.

AgentCommand

* An AgentCommand specifies a one-time executable program for the agent to run.

JSON representation 
{
  "command": string,
  "parameters": {
    string: string,
    ...
  }
}
Fields
command

string

command is the name of the agent one-time executable that will be invoked.
parameters

map (key: string, value: string)

parameters is a map of key/value pairs that can be used to specify additional one-time executable settings.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ShellCommand

  • A ShellCommand is invoked via the agent's command line executor
JSON representation 
{
  "command": string,
  "args": string,
  "timeoutSeconds": integer
}
Fields
command

string

command is the name of the command to be executed.
args

string

args is a string of arguments to be passed to the command.
timeoutSeconds

integer

Optional. If not specified, the default timeout is 60 seconds.

Type

Enum of execution result type

Enums
TYPE_UNSPECIFIED Unknown state
TYPE_PASSED resource successfully passed the rule
TYPE_VIOLATED resource violated the rule