Method: projects.locations.list

このサービスでサポートされているロケーションに関する情報をリストします。このメソッドは次の 2 つの方法で呼び出すことができます。

  • すべての公開ロケーションを一覧表示する: パス GET /v1/locations を使用します。
  • プロジェクトで表示可能なロケーションを一覧表示する: パス GET /v1/projects/{projectId}/locations を使用します。これには、一般公開のロケーションだけでなく、プロジェクトに固有の非公開のロケーションやその他のロケーションも含まれます。

HTTP リクエスト

GET https://vectorsearch.googleapis.com/v1beta/{name}/locations

パスパラメータ

パラメータ
name

string

ロケーションのコレクションを所有するリソース（該当する場合）。

クエリ パラメータ

パラメータ
filter

string

結果を絞り込んで、目的のサブセットに限定するフィルタ。フィルタリング言語は "displayName=tokyo" のような文字列を受け入れます。詳細については AIP-160 をご覧ください。
pageSize

integer

返される結果の最大件数です。設定されていない場合、サービスはデフォルトを選択します。
pageToken

string

レスポンスの nextPageToken フィールドから受け取ったページトークン。そのページトークンを送信して、後続のページを受け取ります。
extraLocationTypes[]

string

省略可。この項目は使用しないでください。明示的に記載されていない限り、これはサポート対象外であり、無視されます。これは主に内部で使用されます。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

次の OAuth スコープが必要です。

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

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

IAM 権限

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

  • vectorsearch.locations.list

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