Method: projects.profiles.list

Lists profiles which have been collected so far and for which the caller has permission to view.

HTTP request

GET https://cloudprofiler.googleapis.com/v2/{parent=projects/*}/profiles

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id} It takes the form projects/{project}.

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

  • cloudprofiler.profiles.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return. Default pageSize is 1000. Max limit is 1000.
pageToken

string

Optional. The token to continue pagination and get profiles from a particular page. When paginating, all other parameters provided to profiles.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

ListProfileResponse contains the list of collected profiles for deployments in projects which the user has permissions to view.

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

JSON representation 
{
  "profiles": [
    {
      object (Profile)
    }
  ],
  "nextPageToken": string,
  "skippedProfiles": integer
}
Fields
profiles[]

object (Profile)

List of profiles fetched.
nextPageToken

string

Token to receive the next page of results. This field maybe empty if there are no more profiles to fetch.
skippedProfiles

integer

Number of profiles that were skipped in the current page since they were not able to be fetched successfully. This should typically be zero. A non-zero value may indicate a transient failure, in which case if the number is too high for your use case, the call may be retried.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.