Method: projects.profiles.create

profiles.create は、オンライン モードで新しいプロファイル リソースを作成します。

この API を直接使用することはおすすめしません。プロファイルの収集には、代わりにサポートされているプロファイラ エージェントを使用してください。

サーバーは、新しいプロファイルをデプロイごとに一定の割合で作成するようにするため、次のプロファイル セッションが利用可能になるまで、作成リクエストがしばらくハングすることがあります。

作成が約 1 分以内に利用できない場合、リクエストは ABORTED エラーで失敗することがあります。レスポンスには、プロファイルを再度作成しようとする前にクライアントが取るべきバックオフの期間が示されます。バックオフ期間は、レスポンス ステータスに関して google.rpc.RetryInfo 拡張機能で返されます。gRPC クライアントでは、拡張機能は「google.rpc.retryinfo-bin」という名前の末尾のメタデータ項目で、バイナリにシリアル化された proto として返されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

プロファイルを作成する親プロジェクト。形式は projects/{project} です。

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

  • cloudprofiler.profiles.create

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "deployment": {
    object (Deployment)
  },
  "profileType": [
    enum (ProfileType)
  ]
}
フィールド
deployment

object (Deployment)

デプロイの詳細。

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

  • cloudprofiler.profiles.create
profileType[]

enum (ProfileType)

エージェントが提供できる 1 つ以上のプロファイル タイプ。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Profile のインスタンスが含まれます。

認可スコープ

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

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

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