- NAME
-
- gcloud beta vector-search collections indexes describe - describe an index
- SYNOPSIS
-
-
gcloud beta vector-search collections indexes describe(INDEX:--collection=COLLECTION--location=LOCATION) [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)Get details about a specific index. - EXAMPLES
-
To describe index
my-indexin collectionmy-collection, projectmy-projectand locationus-central1, run:gcloud beta vector-search collections indexes describe my-index --collection=my-collection --location=us-central1 --project=my-project - POSITIONAL ARGUMENTS
-
-
Index resource - Name of the resource The arguments in this group can be used to
specify the attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
indexon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
INDEX-
ID of the index or fully qualified identifier for the index.
To set the
indexattribute:-
provide the argument
indexon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--collection=COLLECTION-
The collection id of the index resource.
To set the
collectionattribute:-
provide the argument
indexon the command line with a fully specified name; -
provide the argument
--collectionon the command line.
-
provide the argument
--location=LOCATION-
The location id of the index resource.
To set the
locationattribute:-
provide the argument
indexon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Index resource - Name of the resource The arguments in this group can be used to
specify the attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - API REFERENCE
-
This command uses the
vectorsearch/v1betaAPI. The full documentation for this API can be found at: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview - NOTES
- This command is currently in beta and might change without notice.
gcloud beta vector-search collections indexes describe
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-10 UTC.