Method: projects.locations.collections.engines.list

プロジェクトに関連付けられているすべての Engine を一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*}/engines

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

パスパラメータ

パラメータ
parent

string

必須。親リソース名（projects/{project}/locations/{location}/collections/{collectionId} など）。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。非対応。
pageToken

string

省略可。非対応。
filter

string

省略可。ソリューション タイプでフィルタします。例: solutionType=SOLUTION_TYPE_SEARCH

リクエストの本文

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

レスポンスの本文

EngineService.ListEngines メソッドに対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "engines": [
    {
      object (Engine)
    }
  ],
  "nextPageToken": string
}
フィールド
engines[]

object (Engine)

お客様のすべての Engine。
nextPageToken

string

非対応。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.engines.list

詳細については、IAM のドキュメントをご覧ください。