Method: projects.locations.instances.report

Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

HTTP request

POST https://notebooks.googleapis.com/v1/{name}:report

Path parameters

Parameters
name

string

Required. Format: projects/{projectId}/locations/{location}/instances/{instanceId}

Request body

The request body contains data with the following structure:

JSON representation
{
  "vmId": string,
  "metadata": {
    string: string,
    ...
  }
}
Fields
vmId

string

Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity

metadata

map (key: string, value: string)

The metadata reported to Notebooks API. This will be merged to the instance metadata store

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

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.