Method: projects.locations.assets.reportAssetFrames

Reports a set of frames.

HTTP request

POST https://migrationcenter.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/assets:reportAssetFrames

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent of the resource.

Query parameters

Parameters
source

string

Required. Reference to a source.

Request body

The request body contains an instance of Frames.

Response body

If successful, the response body is empty.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Frames

Collection of frame data.

JSON representation 
{
  "framesData": [
    {
      object (AssetFrame)
    }
  ]
}
Fields
framesData[]

object (AssetFrame)

A repeated field of asset data.

AssetFrame

Contains data reported from an inventory source on an asset.

JSON representation 
{
  "reportTime": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": {
    string: string,
    ...
  },
  "performanceSamples": [
    {
      object (PerformanceSample)
    }
  ],
  "traceToken": string,

  // Union field FrameData can be only one of the following:
  "virtualMachineDetails": {
    object (VirtualMachineDetails)
  }
  // End of list of possible types for union field FrameData.
}
Fields
reportTime

string (Timestamp format)

The time the data was reported.

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".
labels

map (key: string, value: string)

Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes

map (key: string, value: string)

Generic asset attributes.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
performanceSamples[]

object (PerformanceSample)

Asset performance data samples.
traceToken

string

Optional. Trace token is optionally provided to assist with debugging and traceability.
Union field FrameData. The internal data of the frame is a oneof field depending on the type of asset information in the frame. FrameData can be only one of the following:
virtualMachineDetails

object (VirtualMachineDetails)

Asset information specific for virtual machines.

PerformanceSample

Performance data sample.

JSON representation 
{
  "sampleTime": string,
  "memory": {
    object (MemoryUsageSample)
  },
  "cpu": {
    object (CpuUsageSample)
  },
  "network": {
    object (NetworkUsageSample)
  },
  "disk": {
    object (DiskUsageSample)
  }
}
Fields
sampleTime

string (Timestamp format)

Time the sample was collected.

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".
memory

object (MemoryUsageSample)

Memory usage sample.
cpu

object (CpuUsageSample)

CPU usage sample.
network

object (NetworkUsageSample)

Network usage sample.
disk

object (DiskUsageSample)

Disk usage sample.

MemoryUsageSample

Memory usage sample.

JSON representation 
{
  "utilizedPercentage": number
}
Fields
utilizedPercentage

number

Percentage of system memory utilized. Must be in the interval [0, 100].

CpuUsageSample

CPU usage sample.

JSON representation 
{
  "utilizedPercentage": number
}
Fields
utilizedPercentage

number

Percentage of total CPU capacity utilized. Must be in the interval [0, 100]. On most systems can be calculated using 100 - idle percentage.

NetworkUsageSample

Network usage sample. Values are across all network interfaces.

JSON representation 
{
  "averageIngressBps": number,
  "averageEgressBps": number
}
Fields
averageIngressBps

number

Average network ingress in B/s sampled over a short window. Must be non-negative.
averageEgressBps

number

Average network egress in B/s sampled over a short window. Must be non-negative.

DiskUsageSample

Disk usage sample. Values are across all disks.

JSON representation 
{
  "averageIops": number
}
Fields
averageIops

number

Average IOPS sampled over a short window. Must be non-negative.