Method: projects.profiles.list

これまでに収集され、呼び出し元が表示権限を持っているプロファイルを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。このプロファイル コレクションを所有する親。形式: projects/{user_project_id}。形式は projects/{project} です。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • cloudprofiler.profiles.list

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返される最大アイテム数。デフォルトの pageSize は 1,000 です。上限は 1,000 です。

pageToken

string

省略可。ページ分けを続行して特定のページからプロフィールを取得するためのトークン。ページ分割を行う場合、profiles.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

ListProfileResponse には、ユーザーが表示権限を持っているプロジェクトのデプロイについて、収集されたプロファイルのリストが含まれます。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "profiles": [
    {
      object (Profile)
    }
  ],
  "nextPageToken": string,
  "skippedProfiles": integer
}
フィールド
profiles[]

object (Profile)

取得したプロファイルのリスト。

nextPageToken

string

結果の次ページを取得するためのトークン。 取得するプロフィールが他にない場合、このフィールドは空になることがあります。

skippedProfiles

integer

正常に取得できなかったために、現在のページでスキップされたプロフィールの数。通常はゼロになります。ゼロ以外の値は一時的な失敗を示している可能性があります。その場合、ユースケースに対して数が大きすぎる場合、呼び出しが再試行される可能性があります。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。