Error Reporting API (clouderrorreporting:v1beta1)

Additions

Methods


• ▼ ▲ clouderrorreporting.projects.locations.deleteEvents

  Path: v1beta1/{+projectName}/events

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/events

  HTTP Method: DELETE

  Parameters:

  projectName

  Description: Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: projectName

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Deletes all error events of a given project.

• ▼ ▲ clouderrorreporting.projects.locations.groups.get

  Path: v1beta1/{+groupName}

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}

  HTTP Method: GET

  Parameters:

  groupName

  Description: Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.

  Pattern: ^projects/[^/]+/locations/[^/]+/groups/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: groupName

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Get the specified group.

• ▼ ▲ clouderrorreporting.projects.locations.groups.update

  Path: v1beta1/{+name}

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}

  HTTP Method: PUT

  Parameters:

  name

  Description: The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.

  Pattern: ^projects/[^/]+/locations/[^/]+/groups/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Replace the data for the specified group. Fails if the group does not exist.

• ▼ ▲ clouderrorreporting.projects.locations.groupStats.list

  Path: v1beta1/{+projectName}/groupStats

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/groupStats

  HTTP Method: GET

  Parameters:

  projectName

  Description: Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID}/locations/{location}` where `{location}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions.

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  groupId

  Description: Optional. List all ErrorGroupStats with these IDs. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice] (https://cloud.google.com/terms/cloud-privacy-notice).

  Location: query

  Repeated: Yes

  Type: string

  serviceFilter.service

  Description: Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).

  Location: query

  Type: string

  serviceFilter.version

  Description: Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).

  Location: query

  Type: string

  serviceFilter.resourceType

  Description: Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).

  Location: query

  Type: string

  timeRange.period

  Description: Restricts the query to the specified time range.

  Location: query

  Type: string

  Enum Descriptions:

  • Do not use.
  • Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.
  • Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.
  • Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.
  • Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.
  • Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day.

  Enum:

  • PERIOD_UNSPECIFIED
  • PERIOD_1_HOUR
  • PERIOD_6_HOURS
  • PERIOD_1_DAY
  • PERIOD_1_WEEK
  • PERIOD_30_DAYS

  timedCountDuration

  Description: Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned.

  Location: query

  Type: string

  Format: google-duration

  alignment

  Description: Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`.

  Location: query

  Type: string

  Enum Descriptions:

  • No alignment specified.
  • The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the alignment_time provided in the request. The alignment_time does not have to be inside the query period but even if it is outside, only time periods are returned which overlap with the query period. A rounded alignment will typically result in a different size of the first or the last time period.
  • The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the end of the requested time period. This can result in a different size of the first time period.

  Enum:

  • ERROR_COUNT_ALIGNMENT_UNSPECIFIED
  • ALIGNMENT_EQUAL_ROUNDED
  • ALIGNMENT_EQUAL_AT_END

  alignmentTime

  Description: Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

  Location: query

  Type: string

  Format: google-datetime

  order

  Description: Optional. The sort order in which the results are returned. Default is `COUNT_DESC`.

  Location: query

  Type: string

  Enum Descriptions:

  • No group order specified.
  • Total count of errors in the given time window in descending order.
  • Timestamp when the group was last seen in the given time window in descending order.
  • Timestamp when the group was created in descending order.
  • Number of affected users in the given time window in descending order.

  Enum:

  • GROUP_ORDER_UNSPECIFIED
  • COUNT_DESC
  • LAST_SEEN_DESC
  • CREATED_DESC
  • AFFECTED_USERS_DESC

  pageSize

  Description: Optional. The maximum number of results to return per response. Default is 20.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

  Location: query

  Type: string

  Parameter Order: projectName

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Lists the specified groups.

• ▼ ▲ clouderrorreporting.projects.locations.events.list

  Path: v1beta1/{+projectName}/events

  Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/events

  HTTP Method: GET

  Parameters:

  projectName

  Description: Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  groupId

  Description: Required. The group for which events shall be returned. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).

  Location: query

  Type: string

  serviceFilter.service

  Description: Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).

  Location: query

  Type: string

  serviceFilter.version

  Description: Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).

  Location: query

  Type: string

  serviceFilter.resourceType

  Description: Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).

  Location: query

  Type: string

  timeRange.period

  Description: Restricts the query to the specified time range.

  Location: query

  Type: string

  Enum Descriptions:

  • Do not use.
  • Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.
  • Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.
  • Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.
  • Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.
  • Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day.

  Enum:

  • PERIOD_UNSPECIFIED
  • PERIOD_1_HOUR
  • PERIOD_6_HOURS
  • PERIOD_1_DAY
  • PERIOD_1_WEEK
  • PERIOD_30_DAYS

  pageSize

  Description: Optional. The maximum number of results to return per response.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Optional. A `next_page_token` provided by a previous response.

  Location: query

  Type: string

  Parameter Order: projectName

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Lists the specified events.