Console
    Contact Us Start free

    ListViolationsResponse

    Response of ListViolations endpoint.

    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.

    Violation

    Workload monitoring Violation.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "beginTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "resolveTime" 
 : 
 string 
 , 
 "category" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "orgPolicyConstraint" 
 : 
 string 
 , 
 "auditLogLink" 
 : 
 string 
 , 
 "nonCompliantOrgPolicy" 
 : 
 string 
 , 
 "remediation" 
 : 
 { 
 object (  Remediation 
 
) 
 } 
 , 
 "acknowledged" 
 : 
 boolean 
 , 
 "exceptionAuditLogLink" 
 : 
 string 
 , 
 "exceptionContexts" 
 : 
 [ 
 { 
 object (  ExceptionContext 
 
) 
 } 
 ] 
 , 
 "acknowledgementTime" 
 : 
 string 
 }
    Fields
    name

    string

    Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}
    description

    string

    Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
    beginTime

    string ( Timestamp format)

    Output only. Time of the event which triggered the Violation.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. The last time when the Violation record was updated.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    resolveTime

    string ( Timestamp format)

    Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    category

    string

    Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
    state

    enum ( State )

    Output only. State of the violation
    orgPolicyConstraint
    (deprecated)

    string

    Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.
    nonCompliantOrgPolicy

    string

    Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folderId}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}
    remediation

    object ( Remediation )

    Output only. Compliance violation remediation
    acknowledged

    boolean

    Output only. A boolean that indicates if the violation is acknowledged
    exceptionContexts[]

    object ( ExceptionContext )

    Output only. List of all the exception detail added for the violation.
    acknowledgementTime

    string ( Timestamp format)

    Optional. Timestamp when this violation was acknowledged last. This will be absent when acknowledged field is marked as false.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    Remediation

    Represents remediation guidance to resolve compliance violation for AssuredWorkload

    JSON representation 
     { 
 "instructions" 
 : 
 { 
 object (  Instructions 
 
) 
 } 
 , 
 "compliantValues" 
 : 
 [ 
 string 
 ] 
 , 
 "remediationType" 
 : 
 enum (  RemediationType 
 
) 
 }
    Fields
    instructions

    object ( Instructions )

    Required. Remediation instructions to resolve violations
    compliantValues[]

    string

    Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
    remediationType

    enum ( RemediationType )

    Output only. Reemediation type based on the type of org policy values violated

    Instructions

    Instructions to remediate violation

    JSON representation 
     { 
 "gcloudInstructions" 
 : 
 { 
 object (  Gcloud 
 
) 
 } 
 , 
 "consoleInstructions" 
 : 
 { 
 object (  Console 
 
) 
 } 
 }
    Fields
    gcloudInstructions

    object ( Gcloud )

    Remediation instructions to resolve violation via gcloud cli
    consoleInstructions

    object ( Console )

    Remediation instructions to resolve violation via cloud console

    Gcloud

    Remediation instructions to resolve violation via gcloud cli

    JSON representation 
     { 
 "gcloudCommands" 
 : 
 [ 
 string 
 ] 
 , 
 "steps" 
 : 
 [ 
 string 
 ] 
 , 
 "additionalLinks" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    gcloudCommands[]

    string

    Gcloud command to resolve violation
    steps[]

    string

    Steps to resolve violation via gcloud cli

    Console

    Remediation instructions to resolve violation via cloud console

    JSON representation 
     { 
 "consoleUris" 
 : 
 [ 
 string 
 ] 
 , 
 "steps" 
 : 
 [ 
 string 
 ] 
 , 
 "additionalLinks" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    consoleUris[]

    string

    Link to console page where violations can be resolved
    steps[]

    string

    Steps to resolve violation via cloud console

    ExceptionContext

    Violation exception detail. Next Id: 6

    JSON representation 
     { 
 "comment" 
 : 
 string 
 , 
 "acknowledgementTime" 
 : 
 string 
 , 
 "userName" 
 : 
 string 
 }
    Fields
    comment

    string

    Business justification provided towards the acknowledgement of the violation.
    acknowledgementTime

    string ( Timestamp format)

    Timestamp when the violation was acknowledged.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    userName

    string

    Name of the user (or service account) who acknowledged the violation.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: