Method: projects.locations.observationJobs.apiObservations.list

apiObservations.list gets all ApiObservations for a given project and location and ObservationJob.

HTTP request

GET https://apim.googleapis.com/v1alpha/{parent=projects/*/locations/*/observationJobs/*}/apiObservations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observationJob}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous apiObservations.list call. Provide this to retrieve the subsequent page.

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

Request body

The request body must be empty.

Response body

Message for response to listing ApiObservations

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

JSON representation 
{
  "apiObservations": [
    {
      object (ApiObservation)
    }
  ],
  "nextPageToken": string
}
Fields
apiObservations[]

object (ApiObservation)

The ApiObservation from the specified project and location and ObservationJobs.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apim.apiObservations.list

For more information, see the IAM documentation.