Method: projects.instances.appProfiles.list

Lists information about app profiles in an instance.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

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

  • bigtable.appProfiles.list

Query parameters

Parameters
pageSize

integer

Maximum number of results per page.

A pageSize of 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 are not required to pass a pageSize. 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

Response message for BigtableInstanceAdmin.ListAppProfiles.

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

JSON representation 
{
  "appProfiles": [
    {
      object (AppProfile)
    }
  ],
  "nextPageToken": string,
  "failedLocations": [
    string
  ]
}
Fields
appProfiles[]

object (AppProfile)

The list of requested app profiles.
nextPageToken

string

Set if not all app profiles could be returned in a single response. Pass this value to pageToken in another request to get the next page of results.
failedLocations[]

string

Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from appProfiles. Values are of the form projects/<project>/locations/<zoneId>

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.