- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- EventView
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 |
Required. Parent value using the form
|
Query parameters
Parameters | |
---|---|
pageSize |
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 |
pageToken |
Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous |
filter |
Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: Multiple filter queries are separated by spaces. Example: By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: |
view |
Optional. Event fields to include in response. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"events": [
{
object ( |
Fields | |
---|---|
events[] |
Output only. List of events. |
nextPageToken |
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[] |
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. |