Method: projects.locations.tensorboards.list

Lists Tensorboards in a Location.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/tensorboards

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

Lists the Tensorboards that match the filter expression.

pageSize

integer

The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageToken

string

A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page.

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

orderBy

string

Field to use to sort the list.

readMask

string (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

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

Response message for TensorboardService.ListTensorboards.

JSON representation
{
  "tensorboards": [
    {
      object (Tensorboard)
    }
  ],
  "nextPageToken": string
}
Fields
tensorboards[]

object (Tensorboard)

The Tensorboards mathching the request.

nextPageToken

string

A token, which can be sent as ListTensorboardsRequest.page_token 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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.tensorboards.list

For more information, see the IAM documentation.