gcloud ai index-endpoints describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud ai index-endpoints describe - gets detailed index endpoint information about the given index endpoint id
- SYNOPSIS
gcloud ai index-endpoints describe(INDEX_ENDPOINT:--region=REGION)[GCLOUD_WIDE_FLAG …]
- EXAMPLES
- Describe an index endpoint
123of projectexampleinregionus-central1, run:gcloudaiindex-endpointsdescribe123--project=example--region=us-central1 - POSITIONAL ARGUMENTS
- Index endpoint resource - The index endpoint to describe. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
index_endpointon the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
INDEX_ENDPOINT- ID of the index_endpoint or fully qualified identifier for the index_endpoint.
To set the
nameattribute:- provide the argument
index_endpointon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- Cloud region for the index_endpoint.
To set the
regionattribute:- provide the argument
index_endpointon the command line with afully specified name; - provide the argument
--regionon the command line; - set the property
ai/region; - choose one from the prompted list of available regions.
- provide the argument
- provide the argument
- Index endpoint resource - The index endpoint to describe. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes 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. - NOTES
- These variants are also available:
gcloudalphaaiindex-endpointsdescribegcloudbetaaiindex-endpointsdescribe
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-16 UTC.