Method: projects.locations.indexEndpoints.list

プロジェクト内のすべての IndexEndpoints を一覧表示します。

HTTP リクエスト

GET https://visionai.googleapis.com/v1/{parent=projects/*/locations/*}/indexEndpoints

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

パスパラメータ

パラメータ
parent

string

必須。形式: projects/{project}/locations/{location}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズです。サーバーはリクエストされた数よりも少ない項目を返す場合があります。サービスが返す値はこれよりも少ないことがあります。指定しない場合、ページサイズは 50 になります。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークンです。
filter

string

省略可。返されたリストに適用されたフィルタ。フィルタリングは deployedImageIndex.image_index フィールドに対してのみサポートされています。ただし、イメージ インデックスではなくコーパスでフィルタするには、deployedImageIndex.corpus を使用します。これにより、指定されたコーパス内に deployedImageIndex.image_index を含むすべてのエンドポイントが返されます。イメージ インデックスの基本フィルタは、deployedImageIndex.image_index = "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index" のようになります。コーパスの基本フィルタは、deployedImageIndex.corpus = "projects/123/locations/us-central1/corpora/my_corpus" のようになります。

リクエストの本文

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

レスポンスの本文

indexEndpoints.list に対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (IndexEndpoint)

IndexEndpoint のリスト。
nextPageToken

string

サーバーが返す必要がある結果のページを特定するトークンです。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。

IAM 権限

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

  • visionai.indexEndpoints.list

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