Method: projects.instances.clusters.hotTablets.list

Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

HTTP request

GET https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*/clusters/*}/hotTablets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The cluster name to list hot tablets. Value is in the following form: projects/{project}/instances/{instance}/clusters/{cluster}.

Authorization requires the following IAM permission on the specified resource parent:

  • bigtable.clusters.listHotTablets

Query parameters

Parameters
startTime

string (Timestamp format)

The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.

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

endTime

string (Timestamp format)

The end time to list hot tablets.

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

pageSize

integer

Maximum number of results per page.

A pageSize that is empty or zero lets the server choose the number of items to return. A pageSize which is strictly positive will return at most that many items. A negative pageSize will cause an error.

Following the first request, subsequent paginated calls do not need a pageSize field. If a pageSize is set in subsequent calls, it must match the pageSize given in the first request.

pageToken

string

The value of nextPageToken returned by a previous call.

Request body

The request body must be empty.

Response body

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

Response message for BigtableInstanceAdmin.ListHotTablets.

JSON representation
{
  "hotTablets": [
    {
      object (HotTablet)
    }
  ],
  "nextPageToken": string
}
Fields
hotTablets[]

object (HotTablet)

List of hot tablets in the tables of the requested cluster that fall within the requested time range. Hot tablets are ordered by node cpu usage percent. If there are multiple hot tablets that correspond to the same tablet within a 15-minute interval, only the hot tablet with the highest node cpu usage will be included in the response.

nextPageToken

string

Set if not all hot tablets could be returned in a single response. Pass this value to pageToken in another request to get the next page of results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.cluster
  • https://www.googleapis.com/auth/bigtable.admin.instance
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.cluster
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

HotTablet

A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.

JSON representation
{
  "name": string,
  "tableName": string,
  "startTime": string,
  "endTime": string,
  "startKey": string,
  "endKey": string,
  "nodeCpuUsagePercent": number
}
Fields
name

string

The unique name of the hot tablet. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*.

tableName

string

Name of the table that contains the tablet. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.

startTime

string (Timestamp format)

Output only. The start time of the hot tablet.

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

endTime

string (Timestamp format)

Output only. The end time of the hot tablet.

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

startKey

string

Tablet Start Key (inclusive).

endKey

string

Tablet End Key (inclusive).

nodeCpuUsagePercent

number

Output only. The average CPU usage spent by a node on this tablet over the startTime to endTime time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet).