Method: projects.locations.dataStores.schemas.list

Schema のリストを取得します。

HTTP リクエスト


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

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

パスパラメータ

パラメータ
parent

string

必須。親データストアのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} 形式）。

クエリ パラメータ

パラメータ
pageSize

integer

返す Schema の最大数。サービスから返される数は、この値より少ない場合があります。

指定されていない場合、最大で 100 個の Schema が返されます。

最大値は 1,000 です。1,000 を超える値は 1,000 に設定されます。
pageToken

string

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

ページ分割を行う場合、SchemaService.ListSchemas に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.schemas.list

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