REST Resource: projects.locations.discoveredApiObservations

Resource: DiscoveredApiObservation

Respresents an API Observation observed in one of the sources.

JSON representation
{
  "name": string,
  "style": enum (Style),
  "serverIps": [
    string
  ],
  "hostname": string,
  "lastEventDetectedTime": string,
  "sourceLocations": [
    string
  ],
  "apiOperationCount": string,
  "origin": string,
  "sourceTypes": [
    enum (SourceType)
  ],
  "knownOperationsCount": string,
  "unknownOperationsCount": string,
  "createTime": string,
  "updateTime": string,
  "sourceMetadata": {
    object (SourceMetadata)
  }
}
Fields
name

string

Identifier. The name of the discovered API Observation.

Format: projects/{project}/locations/{location}/discoveredApiObservations/{discoveredApiObservation}

style

enum (Style)

Optional. Style of ApiObservation

serverIps[]

string

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

Optional. The hostname of requests processed for this Observation.

lastEventDetectedTime

string (Timestamp format)

Optional. Last event detected time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

sourceLocations[]

string

Optional. The location of the observation source.

apiOperationCount

string (int64 format)

Optional. The number of observed API Operations.

origin

string

Optional. For an observation pushed from a gcp resource, this would be the gcp project id.

sourceTypes[]

enum (SourceType)

Optional. The type of the source from which the observation was collected.

knownOperationsCount

string (int64 format)

Output only. The number of known API Operations.

unknownOperationsCount

string (int64 format)

Output only. The number of unknown API Operations.

createTime

string (Timestamp format)

Output only. Create time stamp of the observation in API Hub.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Update time stamp of the observation in API Hub.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

sourceMetadata

object (SourceMetadata)

Output only. The metadata of the source from which the observation was collected.

Style

DiscoveredApiObservation protocol style

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

SourceType

The possible types of the source from which the observation was collected.

Enums
SOURCE_TYPE_UNSPECIFIED Source type not specified.
GCP_XLB GCP external load balancer.
GCP_ILB GCP internal load balancer.

Methods

get

Gets a DiscoveredAPIObservation in a given project, location and ApiObservation.

list

Lists all the DiscoveredAPIObservations in a given project and location.