Method: projects.locations.dataStores.get

DataStore を取得します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/dataStores/*}

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

パスパラメータ

パラメータ
name

string

必須。DataStore の完全なリソース名（projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} など）。

呼び出し元に DataStore へのアクセス権がない場合は、存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

リクエストされた DataStore が存在しない場合は、NOT_FOUND エラーが返されます。

クエリ パラメータ

パラメータ
view

enum (DataStoreView)

省略可。返された DataStore に適用するビュー。指定しない場合は、デフォルトで DataStoreView.DATA_STORE_VIEW_BASIC になります。

DataStoreView.DATA_STORE_VIEW_FULL は、コネクタを基盤とするデータストアの DataStore.icon_uri も設定します。コネクタ アイコンの解決には追加のルックアップが必要になるため、呼び出し元がアイコンをレンダリングする場合にのみリクエストしてください。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.dataStores.get

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