REST Resource: projects.locations.observationJobs.apiObservations

Resource: ApiObservation

Message describing ApiObservation object

JSON representation
{
  "name": string,
  "style": enum (Style),
  "serverIps": [
    string
  ],
  "hostname": string,
  "sourceLocations": [
    string
  ],
  "tags": [
    string
  ],
  "apiOperationCount": string,
  "createTime": string,
  "updateTime": string,
  "lastEventDetectedTime": string
}
Fields
name

string

Identifier. Name of resource

style

enum (Style)

Style of ApiObservation

serverIps[]

string

The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".

hostname

string

The hostname of requests processed for this Observation.

sourceLocations[]

string

Location of the Observation Source, for example "us-central1" or "europe-west1."

tags[]

string

User-defined tags to organize and sort

apiOperationCount

string (int64 format)

The number of observed API Operations.

createTime

string (Timestamp format)

Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lastEventDetectedTime

string (Timestamp format)

Last event detected time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Style

ApiObservation protocol style For MVP, only support REST and unknown protocol

Enums
STYLE_UNSPECIFIED Unknown style
REST Style is Rest API
GRPC Style is Grpc API
GRAPHQL Style is GraphQL API

Methods

batchEditTags

BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

get

GetApiObservation retrieves a single ApiObservation by name.

list

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.