Method: projects.locations.indexEndpoints.list

Répertorie tous les points de terminaison d'index d'un projet.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Format : projects/{project}/locations/{location}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Taille de la page demandée. Le serveur peut renvoyer moins d'éléments que demandé. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, une taille de page de 50 est utilisée. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.

pageToken

string

Facultatif. Jeton identifiant une page de résultats que le serveur doit renvoyer.

filter

string

Facultatif. Filtre appliqué à la liste renvoyée. Seul le champ deployedImageIndex.image_index est compatible avec le filtrage. Toutefois, pour filtrer par corpus plutôt que par indice d'image, utilisez simplement deployedImageIndex.corpus, qui renverra tous les points de terminaison avec deployedImageIndex.image_index dans le corpus donné. Un filtre de base sur l'index d'image se présente comme suit: deployedImageIndex.image_index = "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index". Un filtre de base sur le corpus se présente comme suit: deployedImageIndex.corpus = "projects/123/locations/us-central1/corpora/my_corpus".

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour indexEndpoints.list.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "indexEndpoints": [
    {
      object (IndexEndpoint)
    }
  ],
  "nextPageToken": string
}
Champs
indexEndpoints[]

object (IndexEndpoint)

Liste des IndexEndpoints.

nextPageToken

string

Jeton identifiant une page de résultats que le serveur doit renvoyer.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • visionai.indexEndpoints.list

Pour en savoir plus, consultez la documentation IAM.