Console
    Contact Us Start free

    Method: projects.locations.events.list

    Lists events under a given project and location.

    HTTP request

    GET https://servicehealth.googleapis.com/v1beta/{parent=projects/*/locations/*}/events

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. Parent value using the form projects/{projectId}/locations/{location}/events .

    projectId - ID of the project for which to list service health events. location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global .

    Query parameters

    Parameters
    page Size

    integer

    Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a nextPageToken that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested pageSize .
    page Token

    string

    Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous events.list call to retrieve the next page of results. When paginating, all other parameters provided to events.list must match the call that provided the page token.
    filter

    string

    Optional. A filter expression that filters resources listed in the response. The expression takes the following forms:
    * field=value for category and state
    * field <, >, <=, or >= value for update_time
    Examples: category=INCIDENT , update_time>="2000-01-01T11:30:00-04:00" , event_impacts.product.product_name:"Eventarc"

    Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE .

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

    Filter is supported for the following fields: category , state , update_time , event_impacts.product.product_name

    view

    enum ( EventView )

    Optional. Event fields to include in response.

    Request body

    The request body must be empty.

    Response body

    Response to request for listing events.

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

    JSON representation 
     { 
 "events" 
 : 
 [ 
 { 
 object (  Event 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "unreachable" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    events[]

    object ( Event )

    Output only. List of events.
    next Page Token

    string

    Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as pageToken to retrieve the next page.

    If this field is not present, there are no subsequent results.
    unreachable[]

    string

    Output only. Locations that could not be reached.

    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:

    • servicehealth.events.list

    For more information, see the IAM documentation .

    EventView

    The event fields to include in events.list API response. This enum lists all possible event views.

    Enums
    EVENT_VIEW_UNSPECIFIED Unspecified event view. Default to EVENT_VIEW_BASIC .
    EVENT_VIEW_BASIC Includes all fields except updates . This view is the default for events.list API.
    EVENT_VIEW_FULL Includes all event fields.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: