Method: projects.locations.dataStores.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

呼び出し元にこのロケーションの DataStore を一覧表示する権限がない場合、このデータストアが存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

クエリ パラメータ

パラメータ
pageSize

integer

返す DataStore の最大数。指定しない場合のデフォルトは 10 です。最大許容値は 50 です。50 を超える値は 50 に強制変換されます。

このフィールドが負の数の場合、INVALID_ARGUMENT が返されます。
pageToken

string

前回の DataStoreService.ListDataStores 呼び出しから受け取ったページトークン ListDataStoresResponse.next_page_token。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、DataStoreService.ListDataStores に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

filter

string

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.dataStores.list

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