{ "canonicalName": "Personalized Service Health", "documentationLink": "https://cloud.google.com/service-health/", "discoveryVersion": "v1", "id": "servicehealth:v1beta", "protocol": "rest", "ownerName": "Google", "mtlsRootUrl": "https://servicehealth.mtls.googleapis.com/", "rootUrl": "https://servicehealth.googleapis.com/", "title": "Service Health API", "kind": "discovery#restDescription", "schemas": { "OrganizationEvent": { "description": "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.", "properties": { "nextUpdateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Incident-only field. The time when the next update can be expected.", "type": "string" }, "startTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The start time of the event, if applicable." }, "eventImpacts": { "type": "array", "description": "Output only. Represents the Google Cloud products and locations impacted by the event.", "items": { "$ref": "EventImpact" }, "readOnly": true }, "name": { "type": "string", "description": "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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). `location` - The location to get the organization events from. `event_id` - Organization event ID to retrieve.", "readOnly": true }, "endTime": { "description": "Output only. The end time of the event, if applicable.", "type": "string", "readOnly": true, "format": "google-datetime" }, "title": { "readOnly": true, "type": "string", "description": "Output only. Brief description for the event." }, "category": { "readOnly": true, "description": "Output only. The category of the event.", "enumDescriptions": [ "Unspecified category.", "Event category for service outage or degradation." ], "type": "string", "enum": [ "EVENT_CATEGORY_UNSPECIFIED", "INCIDENT" ] }, "detailedState": { "readOnly": true, "description": "Output only. The current detailed state of the incident.", "type": "string", "enum": [ "DETAILED_STATE_UNSPECIFIED", "EMERGING", "CONFIRMED", "RESOLVED", "MERGED", "AUTO_CLOSED", "FALSE_POSITIVE" ], "enumDescriptions": [ "Unspecified detail state.", "Google engineers are actively investigating the incident to determine the impact.", "The incident is confirmed and impacting at least one Google Cloud product. Ongoing status updates will be provided until it is resolved.", "The incident is no longer affecting any Google Cloud product, and there will be no further updates.", "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.", "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.", "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." ] }, "updates": { "description": "Output only. Incident-only field. Event updates are correspondence from Google.", "type": "array", "readOnly": true, "items": { "$ref": "EventUpdate" } }, "detailedCategory": { "enumDescriptions": [ "Unspecified detailed category.", "Indicates an event with category INCIDENT has a confirmed impact to at least one Google Cloud product.", "Indicates an event with category INCIDENT is under investigation to determine if it has a confirmed impact on any Google Cloud products." ], "type": "string", "enum": [ "DETAILED_CATEGORY_UNSPECIFIED", "CONFIRMED_INCIDENT", "EMERGING_INCIDENT" ], "description": "Output only. The detailed category of the event.", "readOnly": true }, "description": { "readOnly": true, "description": "Output only. Free-form, human-readable description.", "type": "string" }, "parentEvent": { "readOnly": true, "type": "string", "description": "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." }, "updateTime": { "type": "string", "description": "Output only. The time the update was posted.", "readOnly": true, "format": "google-datetime" }, "state": { "description": "Output only. The current state of the event.", "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CLOSED" ], "enumDescriptions": [ "Unspecified state.", "Event is actively affecting a Google Cloud product and will continue to receive updates.", "Event is no longer affecting the Google Cloud product or has been merged with another event." ] } }, "type": "object", "id": "OrganizationEvent" }, "OrganizationImpact": { "id": "OrganizationImpact", "description": "Represents impact to assets at organizational level. It is a read-only view and does not allow any modifications.", "properties": { "name": { "type": "string", "description": "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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). `location` - The location of the organization impact. `organization_impact_id` - ID of the [OrganizationImpact resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact).", "readOnly": true }, "asset": { "description": "Output only. Google Cloud asset possibly impacted by the specified events.", "readOnly": true, "$ref": "Asset" }, "events": { "type": "array", "description": "Output only. A list of event names impacting the asset.", "items": { "type": "string" }, "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the affected project was last modified.", "type": "string" } }, "type": "object" }, "ListArtifactsResponse": { "id": "ListArtifactsResponse", "type": "object", "description": "Message for response to listing Artifacts.", "properties": { "artifacts": { "readOnly": true, "items": { "$ref": "Artifact" }, "description": "Output only. List of artifacts.", "type": "array" }, "unreachable": { "items": { "type": "string" }, "readOnly": true, "type": "array", "description": "Output only. Unordered list. Locations that could not be reached." }, "nextPageToken": { "description": "Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.", "type": "string", "readOnly": true } } }, "Artifact": { "id": "Artifact", "type": "object", "description": "Represents a report for a Google Cloud outage.", "properties": { "updateTime": { "type": "string", "description": "Output only. The time when the artifact was last modified.", "readOnly": true, "format": "google-datetime" }, "category": { "enumDescriptions": [ "Unspecified artifact type.", "Represents an incident report." ], "type": "string", "enum": [ "ARTIFACT_CATEGORY_UNSPECIFIED", "ARTIFACT_CATEGORY_INCIDENT_REPORT" ], "description": "Output only. The type of artifact.", "readOnly": true }, "content": { "description": "The content of the artifact.", "$ref": "Content" }, "createTime": { "description": "Output only. The time when the artifact was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "name": { "description": "Identifier. Example name: `projects/123/locations/global/artifacts/647381984`. The final segment of the name will be the unique UUID generated for the artifact.", "type": "string" } } }, "Status": { "id": "Status", "type": "object", "description": "Represents the current status of Service Health processing.", "properties": { "state": { "description": "Represents the current state of Service Health.", "enumDescriptions": [ "Unspecified state.", "No internal Service Health problems or degradation.", "Service Health interruptions are present." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "OK", "ISSUES_DETECTED" ] }, "issues": { "type": "array", "description": "Optional. List of issues.", "items": { "$ref": "Issue" } } } }, "Event": { "id": "Event", "type": "object", "description": "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.", "properties": { "parentEvent": { "description": "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.", "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time when the event was last modified." }, "state": { "enumDescriptions": [ "Unspecified state.", "Event is actively affecting a Google Cloud product and will continue to receive updates.", "Event is no longer affecting the Google Cloud product or has been merged with another event." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CLOSED" ], "description": "Output only. The current state of the event.", "readOnly": true }, "artifacts": { "items": { "$ref": "ArtifactInfo" }, "description": "Artifacts related to this event, such as incident reports.", "type": "array" }, "nextUpdateTime": { "type": "string", "description": "Output only. The time when the next update can be expected.", "readOnly": true, "format": "google-datetime" }, "startTime": { "type": "string", "description": "Output only. The start time of the event, if applicable.", "readOnly": true, "format": "google-datetime" }, "eventImpacts": { "description": "Google Cloud products and locations impacted by the event.", "type": "array", "items": { "$ref": "EventImpact" } }, "name": { "type": "string", "description": "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}`.", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The end time of the event, if applicable.", "type": "string" }, "title": { "readOnly": true, "type": "string", "description": "Output only. Brief description for the event." }, "category": { "readOnly": true, "description": "Output only. The category of the event.", "type": "string", "enum": [ "EVENT_CATEGORY_UNSPECIFIED", "INCIDENT" ], "enumDescriptions": [ "Unspecified category.", "Event category for service outage or degradation." ] }, "detailedState": { "readOnly": true, "description": "Output only. The current detailed state of the incident.", "enumDescriptions": [ "Unspecified detail state.", "Google engineers are actively investigating the event to determine the impact.", "The incident is confirmed and impacting at least one Google Cloud product. Ongoing status updates will be provided until it is resolved.", "The incident is no longer affecting any Google Cloud product, and there will be no further updates.", "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.", "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.", "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." ], "type": "string", "enum": [ "DETAILED_STATE_UNSPECIFIED", "EMERGING", "CONFIRMED", "RESOLVED", "MERGED", "AUTO_CLOSED", "FALSE_POSITIVE" ] }, "updates": { "description": "Output only. Event updates are correspondence from Google.", "type": "array", "readOnly": true, "items": { "$ref": "EventUpdate" } }, "detailedCategory": { "description": "The detailed category of the event.", "enumDescriptions": [ "Unspecified detailed category.", "Indicates an event with category INCIDENT has a confirmed impact to at least one Google Cloud product.", "Indicates an event with category INCIDENT is under investigation to determine if it has a confirmed impact on any Google Cloud products." ], "type": "string", "enum": [ "DETAILED_CATEGORY_UNSPECIFIED", "CONFIRMED_INCIDENT", "EMERGING_INCIDENT" ] }, "relevance": { "type": "string", "enum": [ "RELEVANCE_UNSPECIFIED", "UNKNOWN", "NOT_IMPACTED", "PARTIALLY_RELATED", "RELATED", "IMPACTED" ], "enumDescriptions": [ "Unspecified relevance.", "The relevance of the incident to the project is unknown.", "The incident does not impact the project.", "The incident is associated with a Google Cloud product your project uses, but the incident may not be impacting your project. For example, the incident may be impacting a Google Cloud product that your project uses, but in a location that your project does not use.", "The incident has a direct connection with your project and impacts a Google Cloud product in a location your project uses.", "The incident is verified to be impacting your project." ], "readOnly": true, "description": "Output only. Communicates why a given event is deemed relevant in the context of a given project." }, "description": { "readOnly": true, "type": "string", "description": "Output only. Free-form, human-readable description." } } }, "EventImpact": { "id": "EventImpact", "type": "object", "description": "Represents the Google Cloud products and locations impacted by the event.", "properties": { "location": { "description": "Location impacted by the event.", "$ref": "Location" }, "product": { "description": "Google Cloud product impacted by the event.", "$ref": "Product" } } }, "EventUpdate": { "description": "Records an update made to the event.", "properties": { "updateTime": { "description": "Output only. The time the update was posted.", "type": "string", "readOnly": true, "format": "google-datetime" }, "description": { "description": "Output only. Free-form, human-readable description.", "type": "string", "readOnly": true }, "symptom": { "description": "Output only. Symptoms of the event, if available.", "type": "string", "readOnly": true }, "title": { "type": "string", "description": "Output only. Brief title for the event.", "readOnly": true }, "workaround": { "readOnly": true, "type": "string", "description": "Output only. Workaround steps to remediate the event impact, if available." } }, "type": "object", "id": "EventUpdate" }, "ListLocationsResponse": { "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array", "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListLocationsResponse" }, "Product": { "id": "Product", "type": "object", "description": "Represents the Google Cloud product impacted by the event.", "properties": { "id": { "description": "Unique identifier for the product.", "type": "string" }, "productName": { "description": "Google Cloud product impacted by the event. Example: `\"Google Cloud SQL\"`", "type": "string" } } }, "ArtifactInfo": { "id": "ArtifactInfo", "type": "object", "description": "Gives some general information about the artifact. This message isn't intended to contain the full artifact or all the metadata, it's simply intended to be a reference to the artifact.", "properties": { "artifact": { "description": "The resource name for the artifact.", "type": "string" }, "artifactCategory": { "description": "Category of the artifact.", "enumDescriptions": [ "Unspecified artifact type.", "Represents an incident report." ], "type": "string", "enum": [ "ARTIFACT_CATEGORY_UNSPECIFIED", "ARTIFACT_CATEGORY_INCIDENT_REPORT" ] } } }, "Issue": { "id": "Issue", "description": "Represents an internal problem with Service Health.", "properties": { "startTime": { "type": "string", "description": "Optional. The time the issue is known to have started.", "format": "google-datetime" }, "message": { "description": "Human-readable message to explain what the issue is.", "type": "string" }, "lastUpdateTime": { "format": "google-datetime", "description": "The time the issue received the most recent update.", "type": "string" }, "details": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Metadata to further specify what the issue is affecting.", "type": "object" } }, "type": "object" }, "Content": { "id": "Content", "type": "object", "description": "Represents the content of an artifact, such as an incident report for a service health incident.", "properties": { "markdown": { "type": "string", "description": "The content of an artifact in markdown." } } }, "ListOrganizationEventsResponse": { "id": "ListOrganizationEventsResponse", "description": "Response to request for listing organization events.", "properties": { "organizationEvents": { "items": { "$ref": "OrganizationEvent" }, "readOnly": true, "type": "array", "description": "Output only. List of organization events affecting an organization." }, "nextPageToken": { "description": "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.", "type": "string", "readOnly": true }, "unreachable": { "items": { "type": "string" }, "readOnly": true, "type": "array", "description": "Output only. Locations that could not be reached." } }, "type": "object" }, "ListOrganizationImpactsResponse": { "description": "Response to request for listing projects under an organization affected by an event.", "properties": { "organizationImpacts": { "items": { "$ref": "OrganizationImpact" }, "readOnly": true, "type": "array", "description": "Output only. List of [impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact) for an organization affected by service health events." }, "nextPageToken": { "description": "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.", "type": "string", "readOnly": true }, "unreachable": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. Locations that could not be reached.", "type": "array" } }, "type": "object", "id": "ListOrganizationImpactsResponse" }, "Asset": { "id": "Asset", "type": "object", "description": "Represents the asset impacted by the events.", "properties": { "assetName": { "description": "Output only. Full name of the resource as defined in [Resource Names](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string", "readOnly": true }, "assetType": { "type": "string", "description": "Output only. Type of the asset. Example: `\"cloudresourcemanager.googleapis.com/Project\"`", "readOnly": true } } }, "Location": { "id": "Location", "description": "Represents the locations impacted by the event.", "properties": { "locationName": { "description": "Location impacted by the event. Example: `\"us-central1\"`", "type": "string" } }, "type": "object" }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "properties": { "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "statusDetail": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true }, "cancelRequested": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation was created.", "type": "string" }, "endTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time the operation finished running.", "type": "string" } }, "type": "object", "id": "OperationMetadata" }, "ListEventsResponse": { "type": "object", "description": "Response to request for listing events.", "properties": { "events": { "description": "Output only. List of events.", "type": "array", "readOnly": true, "items": { "$ref": "Event" } }, "nextPageToken": { "description": "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.", "type": "string", "readOnly": true }, "unreachable": { "description": "Output only. Locations that could not be reached.", "type": "array", "readOnly": true, "items": { "type": "string" } } }, "id": "ListEventsResponse" }, "GoogleCloudLocationLocation": { "id": "GoogleCloudLocationLocation", "type": "object", "description": "A resource that represents a Google Cloud location.", "properties": { "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "metadata": { "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." } } } }, "version_module": true, "basePath": "", "servicePath": "", "baseUrl": "https://servicehealth.googleapis.com/", "fullyEncodeReservedExpansion": true, "ownerDomain": "google.com", "revision": "20260731", "name": "servicehealth", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/servicehealth": { "description": "See, edit, configure, and delete your Google Cloud Service Health data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/servicehealth.readonly": { "description": "See your Google Cloud Service Health data and the email address of your Google Account" } } } }, "resources": { "organizations": { "resources": { "locations": { "methods": { "getStatus": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/status", "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. Name of the resource.", "pattern": "^organizations/[^/]+/locations/[^/]+/status$", "required": true } }, "parameterOrder": [ "name" ], "description": "Retrieves health status of Service Health using an organization resource.", "id": "servicehealth.organizations.locations.getStatus", "path": "v1beta/{+name}", "response": { "$ref": "Status" } } }, "resources": { "organizationEvents": { "methods": { "list": { "httpMethod": "GET", "parameters": { "pageSize": { "description": "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`.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "type": "string", "description": "Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: * field=value for `category` and `state` * field \u003c, \u003e, \u003c=, or \u003e= value for `update_time` Examples: `category=INCIDENT`, `update_time\u003e=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`", "location": "query" }, "pageToken": { "description": "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.", "location": "query", "type": "string" }, "parent": { "type": "string", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "description": "Required. Parent value using the form `organizations/{organization_id}/locations/{location}/organizationEvents`. `organization_id` - ID (number) of the organization that contains the event. To get your `organization_id`, see [Getting your organization resource ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). `location` - The location to get organization events from. Set this field to `global`." }, "view": { "location": "query", "enumDescriptions": [ "Unspecified event view. Default to `ORGANIZATION_EVENT_VIEW_BASIC`.", "Includes all organization event fields except `updates`. This view is the default for ListOrganizationEvents API.", "Includes all organization event fields." ], "type": "string", "enum": [ "ORGANIZATION_EVENT_VIEW_UNSPECIFIED", "ORGANIZATION_EVENT_VIEW_BASIC", "ORGANIZATION_EVENT_VIEW_FULL" ], "description": "Optional. OrganizationEvent fields to include in response." } }, "parameterOrder": [ "parent" ], "description": "Lists organization events under a given organization and location.", "id": "servicehealth.organizations.locations.organizationEvents.list", "path": "v1beta/{+parent}/organizationEvents", "response": { "$ref": "ListOrganizationEventsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/organizationEvents" }, "get": { "httpMethod": "GET", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/organizationEvents/[^/]+$", "required": true, "description": "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 organization that contains the event. To get your `organization_id`, see [Getting your organization resource ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). `event_id` - Organization event ID to retrieve.", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "description": "Retrieves a resource containing information about an event affecting an organization.", "id": "servicehealth.organizations.locations.organizationEvents.get", "path": "v1beta/{+name}", "response": { "$ref": "OrganizationEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/organizationEvents/{organizationEventsId}" } } }, "organizationImpacts": { "methods": { "get": { "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/organizationImpacts/{organizationImpactsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "id": "servicehealth.organizations.locations.organizationImpacts.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/organizationImpacts/[^/]+$", "required": true, "description": "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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). `organization_impact_id` - ID of the [OrganizationImpact resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact).", "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "description": "Retrieves a resource containing information about impact to an asset under an organization affected by a service health event.", "response": { "$ref": "OrganizationImpact" }, "path": "v1beta/{+name}" }, "list": { "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value using the form `organizations/{organization_id}/locations/{location}/organizationImpacts`. `organization_id` - ID (number) of the project that contains the event. To get your `organization_id`, see [Getting your organization resource ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). `location` - The location to get organization impacts from. Set this field to `global`.", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "pageSize": { "type": "integer", "description": "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](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact) than the requested `page_size`.", "location": "query", "format": "int32" }, "filter": { "description": "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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_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`.", "location": "query", "type": "string" }, "pageToken": { "description": "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Lists assets impacted by organization events under a given organization and location.", "id": "servicehealth.organizations.locations.organizationImpacts.list", "path": "v1beta/{+parent}/organizationImpacts", "response": { "$ref": "ListOrganizationImpactsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/organizations/{organizationsId}/locations/{locationsId}/organizationImpacts" } } } } } } }, "projects": { "resources": { "locations": { "resources": { "events": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/events/{eventsId}", "path": "v1beta/{+name}", "response": { "$ref": "Event" }, "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/events/[^/]+$", "required": true, "description": "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. Set this field to `global`. `event_id` - Event ID to retrieve." } }, "parameterOrder": [ "name" ], "description": "Retrieves a resource containing information about an event.", "id": "servicehealth.projects.locations.events.get" }, "list": { "path": "v1beta/{+parent}/events", "response": { "$ref": "ListEventsResponse" }, "httpMethod": "GET", "parameters": { "parent": { "description": "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 service health events from. Set this field to `global`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "view": { "description": "Optional. Event fields to include in response.", "type": "string", "enum": [ "EVENT_VIEW_UNSPECIFIED", "EVENT_VIEW_BASIC", "EVENT_VIEW_FULL" ], "location": "query", "enumDescriptions": [ "Unspecified event view. Default to `EVENT_VIEW_BASIC`.", "Includes all fields except `updates`. This view is the default for ListEvents API.", "Includes all event fields." ] }, "pageSize": { "description": "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`.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: * field=value for `category` and `state` * field \u003c, \u003e, \u003c=, or \u003e= value for `update_time` Examples: `category=INCIDENT`, `update_time\u003e=\"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`", "location": "query", "type": "string" }, "pageToken": { "description": "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Lists events under a given project and location.", "id": "servicehealth.projects.locations.events.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/events" } } }, "artifacts": { "methods": { "list": { "path": "v1beta/{+parent}/artifacts", "response": { "$ref": "ListArtifactsResponse" }, "httpMethod": "GET", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. Parent value for ListArtifactsRequest `projects/{project_id}/locations/{location_id}`. `project_id` - Project ID of the project that contains the artifact. `location` - The location to get the service health artifacts from. Set this field to `global`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of events to return. The service may return fewer events than this value. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ‘ListArtifacts’ call to retrieve the next page of results. When paginating, all other parameters provided to ‘ListArtifacts’ must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Lists Artifacts under a given project and location.", "id": "servicehealth.projects.locations.artifacts.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/artifacts" }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "id": "servicehealth.projects.locations.artifacts.get", "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", "required": true, "description": "Required. Name of the resource using the form `projects/{project_id}/locations/{location}/artifacts/{artifact_id}`. `project_id` - Project ID of the project that contains the artifact. `location` - The location of the event that the artifact is associated with. Set this field to `global`. `artifact_id` - Artifact ID to retrieve." } }, "parameterOrder": [ "name" ], "description": "Retrieves a resource containing information about an artifact, such as an incident report.", "response": { "$ref": "Artifact" }, "path": "v1beta/{+name}" } } } }, "methods": { "list": { "response": { "$ref": "ListLocationsResponse" }, "path": "v1beta/{+name}/locations", "id": "servicehealth.projects.locations.list", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+$", "required": true, "description": "The resource that owns the locations collection, if applicable.", "location": "path", "type": "string" }, "filter": { "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ] }, "getStatus": { "path": "v1beta/{+name}", "response": { "$ref": "Status" }, "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource.", "pattern": "^projects/[^/]+/locations/[^/]+/status$", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "description": "Retrieves health status of Service Health.", "id": "servicehealth.projects.locations.getStatus", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/status" }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicehealth", "https://www.googleapis.com/auth/servicehealth.readonly" ], "id": "servicehealth.projects.locations.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "description": "Gets information about a location.", "response": { "$ref": "GoogleCloudLocationLocation" }, "path": "v1beta/{+name}" } } } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "description": "Personalized Service Health helps you gain visibility into disruptive events impacting Google Cloud products. ", "batchPath": "batch", "version": "v1beta", "parameters": { "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string", "enum": [ "json", "media", "proto" ], "default": "json", "description": "Data format for response." }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "enum": [ "1", "2" ], "description": "V1 error format." }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean", "default": "true" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" } } }