Package google.cloud.servicehealth.v1beta

Index

ServiceHealth

Request service health events relevant to your Google Cloud project.

GetEvent

rpc GetEvent(GetEventRequest) returns (Event)

Retrieves a resource containing information about an event.

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 name resource:

  • servicehealth.events.get

For more information, see the IAM documentation.
GetOrganizationEvent

rpc GetOrganizationEvent(GetOrganizationEventRequest) returns (OrganizationEvent)

Retrieves a resource containing information about an event affecting an organization .

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 name resource:

  • servicehealth.organizationEvents.get

For more information, see the IAM documentation.
GetOrganizationImpact

rpc GetOrganizationImpact(GetOrganizationImpactRequest) returns (OrganizationImpact)

Retrieves a resource containing information about impact to an asset under an organization affected by a service health event.

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 name resource:

  • servicehealth.organizationImpacts.get

For more information, see the IAM documentation.
GetStatus

rpc GetStatus(GetStatusRequest) returns (Status)

Retrieves health status of Service Health.

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 name resource:

  • servicehealth.statuses.get

For more information, see the IAM documentation.
GetStatusForOrganization

rpc GetStatusForOrganization(GetStatusRequest) returns (Status)

Retrieves health status of Service Health using an organization resource.

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 name resource:

  • servicehealth.statuses.get

For more information, see the IAM documentation.
ListEvents

rpc ListEvents(ListEventsRequest) returns (ListEventsResponse)

Lists events under a given project and location.

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.
ListOrganizationEvents

rpc ListOrganizationEvents(ListOrganizationEventsRequest) returns (ListOrganizationEventsResponse)

Lists organization events under a given organization and location.

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.organizationEvents.list

For more information, see the IAM documentation.
ListOrganizationImpacts

rpc ListOrganizationImpacts(ListOrganizationImpactsRequest) returns (ListOrganizationImpactsResponse)

Lists assets impacted by organization events under a given organization and location.

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.organizationImpacts.list

For more information, see the IAM documentation.

Asset

Represents the asset impacted by the events.

Fields
asset_name

string

Output only. Full name of the resource as defined in Resource Names.
asset_type

string

Output only. Type of the asset. Example: "cloudresourcemanager.googleapis.com/Project"

Event

Represents service health events that may affect Google Cloud products. Event resource is a read-only view and does not allow any modifications. All fields are output only.

Fields
name

string

Output only. Identifier. Name of the event. Unique name of the event in this scope including project and location using the form projects/{project_id}/locations/{location}/events/{event_id}.
title

string

Output only. Brief description for the event.
description

string

Output only. Free-form, human-readable description.
category

EventCategory

Output only. The category of the event.
detailed_category

DetailedCategory

The detailed category of the event.
state

State

Output only. The current state of the event.
detailed_state

DetailedState

Output only. The current detailed state of the incident.
event_impacts[]

EventImpact

Google Cloud products and locations impacted by the event.
relevance

Relevance

Output only. Communicates why a given event is deemed relevant in the context of a given project.
updates[]

EventUpdate

Output only. Event updates are correspondence from Google.
parent_event

string

Output only. When detailed_state=MERGED, parent_event contains the name of the parent event. All further updates will be published to the parent event.
update_time

Timestamp

Output only. The time when the event was last modified.
start_time

Timestamp

Output only. The start time of the event, if applicable.
end_time

Timestamp

Output only. The end time of the event, if applicable.
next_update_time

Timestamp

Output only. The time when the next update can be expected.

DetailedCategory

The detailed category of an event. Contains all possible states for all event categories.

Enums
DETAILED_CATEGORY_UNSPECIFIED Unspecified detailed category.
CONFIRMED_INCIDENT Indicates an event with category INCIDENT has a confirmed impact to at least one Google Cloud product.
EMERGING_INCIDENT Indicates an event with category INCIDENT is under investigation to determine if it has a confirmed impact on any Google Cloud products.

DetailedState

The detailed state of the incident. This enum lists all possible detailed states of an incident.

Enums
DETAILED_STATE_UNSPECIFIED Unspecified detail state.
EMERGING Google engineers are actively investigating the event to determine the impact.
CONFIRMED The incident is confirmed and impacting at least one Google Cloud product. Ongoing status updates will be provided until it is resolved.
RESOLVED The incident is no longer affecting any Google Cloud product, and there will be no further updates.
MERGED The incident was merged into a parent incident. All further updates will be published to the parent only. The parent_event field contains the name of the parent.
AUTO_CLOSED

The incident was automatically closed because of the following reasons:

  • The impact of the incident could not be confirmed.
  • The incident was intermittent or resolved itself.

The incident does not have a resolution because no action or investigation happened. If it is intermittent, the incident may reopen.
FALSE_POSITIVE Upon investigation, Google engineers concluded that the incident is not affecting a Google Cloud product. This state can change if the incident is reviewed again.

EventCategory

The category of the event. This enum lists all possible categories of event.

Enums
EVENT_CATEGORY_UNSPECIFIED Unspecified category.
INCIDENT Event category for service outage or degradation.

Relevance

Communicates why a given incident is deemed relevant in the context of a given project. This enum lists all possible detailed states of relevance.

Enums
RELEVANCE_UNSPECIFIED Unspecified relevance.
UNKNOWN The relevance of the incident to the project is unknown.
NOT_IMPACTED The incident does not impact the project.
RELATED The incident has a direct connection with your project and impacts a Google Cloud product in a location your project uses.
IMPACTED The incident is verified to be impacting your project.

State

The state of the event. This enum lists all possible states of event.

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE Event is actively affecting a Google Cloud product and will continue to receive updates.
CLOSED Event is no longer affecting the Google Cloud product or has been merged with another event.

EventImpact

Represents the Google Cloud products and locations impacted by the event.

Fields
product

Product

Google Cloud product impacted by the event.
location

Location

Location impacted by the event.

EventUpdate

Records an update made to the event.

Fields
update_time

Timestamp

Output only. The time the update was posted.
title

string

Output only. Brief title for the event.
description

string

Output only. Free-form, human-readable description.
symptom

string

Output only. Symptoms of the event, if available.
workaround

string

Output only. Workaround steps to remediate the event impact, if available.

EventView

The event fields to include in ListEvents 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 ListEvents API.
EVENT_VIEW_FULL Includes all event fields.

GetEventRequest

Gets information about a specific event.

Fields
name

string

Required. Unique name of the event in this scope including project and location using the form projects/{project_id}/locations/{location}/events/{event_id}.

project_id - Project ID of the project that contains the event.
location - The location to get the service health events from.
event_id - Event ID to retrieve.

GetOrganizationEventRequest

Gets information about a specific event affecting an organization.

Fields
name

string

Required. Unique name of the event in this scope including organization and event ID using the form organizations/{organization_id}/locations/locations/global/organizationEvents/{event_id}.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
event_id - Organization event ID to retrieve.

GetOrganizationImpactRequest

Gets information about an event that affects a project under an organization.

Fields
name

string

Required. Name of the resource using the form organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}.

organization_id - ID (number) of the organization that contains the event. To get your organization_id, see Getting your organization resource ID.
organization_impact_id - ID of the OrganizationImpact resource.

GetStatusRequest

Message for getting a status.

Fields
name

string

Required. Name of the resource.

Issue

Represents an internal problem with Service Health.

Fields
message

string

Human-readable message to explain what the issue is.
start_time

Timestamp

Optional. The time the issue is known to have started.
last_update_time

Timestamp

The time the issue received the most recent update.
details

Struct

Metadata to further specify what the issue is affecting.

ListEventsRequest

Requests list of events.

Fields
parent

string

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

project_id - 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.
page_size

int32

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 next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.
page_token

string

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents 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

EventView

Optional. Event fields to include in response.

ListEventsResponse

Response to request for listing events.

Fields
events[]

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 page_token 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.

ListOrganizationEventsRequest

Requests list of events that affect an organization.

Fields
parent

string

Required. Parent value using the form organizations/{organization_id}/locations/{location}.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.
page_size

int32

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 next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.
page_token

string

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

Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

When paginating, all other parameters provided to ListOrganizationEvents 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

Multiple filter queries are space-separated. 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
view

OrganizationEventView

Optional. OrganizationEvent fields to include in response.

ListOrganizationEventsResponse

Response to request for listing organization events.

Fields
organization_events[]

OrganizationEvent

Output only. List of organization events affecting an organization.
next_page_token

string

Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token 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.

ListOrganizationImpactsRequest

Requests list of projects under an organization affected by an event.

Fields
parent

string

Required. Parent value using the form organizations/{organization_id}/locations/{location}.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.
location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.
page_size

int32

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 next_page_token that can be used to get the next page of results in subsequent list requests. The service may return fewer impacts than the requested page_size.
page_token

string

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

Provide page_token returned by a previous ListOrganizationImpacts call to retrieve the next page of results.

When paginating, all other parameters provided to ListOrganizationImpacts must match the call that provided the page token.
filter

string

Optional. A filter expression that filters resources listed in the response. The expression is in the form of field:value for checking if a repeated field contains a value.

Example: events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id

To get your {organization_id}, see Getting your organization resource ID.

Multiple filter queries are separated by spaces.

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. Filter is supported for the following fields: events.

ListOrganizationImpactsResponse

Response to request for listing projects under an organization affected by an event.

Fields
organization_impacts[]

OrganizationImpact

Output only. List of impacts for an organization affected by service health 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 page_token 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.

Location

Represents the locations impacted by the event.

Fields
location_name

string

Location impacted by the event. Example: "us-central1"

OrganizationEvent

Represents service health events that may affect Google Cloud products used across the organization. It is a read-only view and does not allow any modifications.

Fields
name

string

Output only. Identifier. Name of the event. Unique name of the event in this scope including organization ID and location using the form organizations/{organization_id}/locations/{location}/organizationEvents/{event_id}.

organization_id - see Getting your organization resource ID.
location - The location to get the service health events from.
event_id - Organization event ID to retrieve.
title

string

Output only. Brief description for the event.
description

string

Output only. Free-form, human-readable description.
category

EventCategory

Output only. The category of the event.
detailed_category

DetailedCategory

Output only. The detailed category of the event.
state

State

Output only. The current state of the event.
detailed_state

DetailedState

Output only. The current detailed state of the incident.
event_impacts[]

EventImpact

Output only. Represents the Google Cloud products and locations impacted by the event.
updates[]

EventUpdate

Output only. Incident-only field. Event updates are correspondence from Google.
parent_event

string

Output only. When detailed_state=MERGED, parent_event contains the name of the parent event. All further updates will be published to the parent event.
update_time

Timestamp

Output only. The time the update was posted.
start_time

Timestamp

Output only. The start time of the event, if applicable.
end_time

Timestamp

Output only. The end time of the event, if applicable.
next_update_time

Timestamp

Output only. Incident-only field. The time when the next update can be expected.

DetailedCategory

The detailed category of an event. Contains all possible states for all event categories.

Enums
DETAILED_CATEGORY_UNSPECIFIED Unspecified detailed category.
CONFIRMED_INCIDENT Indicates an event with category INCIDENT has a confirmed impact to at least one Google Cloud product.
EMERGING_INCIDENT Indicates an event with category INCIDENT is under investigation to determine if it has a confirmed impact on any Google Cloud products.

DetailedState

The detailed state of the incident. This enum lists all possible detailed states of an incident.

Enums
DETAILED_STATE_UNSPECIFIED Unspecified detail state.
EMERGING Google engineers are actively investigating the incident to determine the impact.
CONFIRMED The incident is confirmed and impacting at least one Google Cloud product. Ongoing status updates will be provided until it is resolved.
RESOLVED The incident is no longer affecting any Google Cloud product, and there will be no further updates.
MERGED The incident was merged into a parent event. All further updates will be published to the parent only. The parent_event contains the name of the parent.
AUTO_CLOSED

The incident was automatically closed because of the following reasons:

  • The impact of the incident could not be confirmed.
  • The incident was intermittent or resolved itself.

The incident does not have a resolution because no action or investigation happened. If it is intermittent, the incident may reopen.
FALSE_POSITIVE Upon investigation, Google engineers concluded that the incident is not affecting a Google Cloud product. This state can change if the incident is reviewed again.

EventCategory

The category of the event. This enum lists all possible categories of event.

Enums
EVENT_CATEGORY_UNSPECIFIED Unspecified category.
INCIDENT Event category for service outage or degradation.

State

The state of the organization event. This enum lists all possible states of event.

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE Event is actively affecting a Google Cloud product and will continue to receive updates.
CLOSED Event is no longer affecting the Google Cloud product or has been merged with another event.

OrganizationEventView

The organization event fields to include in ListOrganizationEvents API response. This enum lists all possible organization event views.

Enums
ORGANIZATION_EVENT_VIEW_UNSPECIFIED Unspecified event view. Default to ORGANIZATION_EVENT_VIEW_BASIC.
ORGANIZATION_EVENT_VIEW_BASIC Includes all organization event fields except updates. This view is the default for ListOrganizationEvents API.
ORGANIZATION_EVENT_VIEW_FULL Includes all organization event fields.

OrganizationImpact

Represents impact to assets at organizational level. It is a read-only view and does not allow any modifications.

Fields
name

string

Output only. Identifier. Unique name of the organization impact in this scope including organization and location using the form organizations/{organization_id}/locations/{location}/organizationImpacts/{organization_impact_id}.

organization_id - ID (number) of the organization that contains the event. To get your organization_id, see Getting your organization resource ID.
organization_impact_id - ID of the OrganizationImpact resource.
events[]

string

Output only. A list of event names impacting the asset.
asset

Asset

Output only. Google Cloud asset possibly impacted by the specified events.
update_time

Timestamp

Output only. The time when the affected project was last modified.

Product

Represents the Google Cloud product impacted by the event.

Fields
product_name

string

Google Cloud product impacted by the event. Example: "Google Cloud SQL"
id

string

Unique identifier for the product.

Status

Represents the current status of Service Health processing.

Fields
state

State

Represents the current state of Service Health.
issues[]

Issue

Optional. List of issues.

State

The state of Service Health.

Enums
STATE_UNSPECIFIED Unspecified state.
OK No internal Service Health problems or degradation.
ISSUES_DETECTED Service Health interruptions are present.