- NAME
-
- gcloud looker instances describe - show metadata for a Looker instance
- SYNOPSIS
-
-
gcloud looker instances describe(INSTANCE:--region=REGION) [--endpoint-mode=ENDPOINT_MODE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
Show metadata for a Looker instance.
This command can fail for the following reasons:
- The instance specified does not exist.
- The active account does not have permission to access the given instance.
- EXAMPLES
-
To display the metadata for an instance with the name
my-looker-instancein the default region, run:gcloud looker instances describe my-looker-instanceTo display all fields of the instance metadata, add the
--format=jsonflag:gcloud looker instances describe my-looker-instance --format=json - POSITIONAL ARGUMENTS
-
-
Instance resource - Arguments and flags that specify the Looker instance you
want to describe. 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
instanceon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
INSTANCE-
ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:-
provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region=REGION-
The name of the Looker region of the instance. Overrides the default
looker/region property value for this command invocation.
To set the
regionattribute:-
provide the argument
instanceon the command line with a fully specified name; -
provide the argument
--regionon the command line; -
set the property
looker/region.
-
provide the argument
-
provide the argument
-
Instance resource - Arguments and flags that specify the Looker instance you
want to describe. 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.
- FLAGS
-
--endpoint-mode=ENDPOINT_MODE-
Specifies endpoint mode for a given command. Regional endpoints provide enhanced
data residency and reliability by ensuring your request is handled entirely
within the specified Google Cloud region. This differs from global endpoints,
which may process parts of the request outside the target region. Overrides the
default
regional/endpoint_modeproperty value for this command invocation.ENDPOINT_MODEmust be one of:global- (Default) Use global rather than regional endpoints.
regional- Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred- Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
- 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
looker/v1API. The full documentation for this API can be found at: https://cloud.google.com/looker/docs/reference/rest/ - REGIONAL ENDPOINTS
-
This command supports regional endpoints. To use regional endpoints for this
command, use the
--endpoint-mode=regional-preferredflag. To use regional endpoints by default, run$ gcloud config set regional/endpoint_mode regional-preferred. - NOTES
-
This variant is also available:
gcloud alpha looker instances describe
gcloud looker instances 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-09-29 UTC.