- NAME
-
- gcloud alpha apihub api-hub-instances describe - describe an Api Hub Instance
- SYNOPSIS
-
-
gcloud alpha apihub api-hub-instances describe(API_HUB_INSTANCE:--location=LOCATION) [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Describe an api hub instance - EXAMPLES
-
To describe the API Hub instance in project
my-projectand locationus-central1, run:gcloud alpha apihub api-hub-instances describe --project=my-project --location=us-central1 - POSITIONAL ARGUMENTS
-
-
ApiHubInstance resource - The name of the Api Hub instance to retrieve. Format:
projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}. 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
api_hub_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.
API_HUB_INSTANCE-
ID of the apiHubInstance or fully qualified identifier for the apiHubInstance.
To set the
api_hub_instanceattribute:-
provide the argument
api_hub_instanceon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location id of the apiHubInstance resource.
To set the
locationattribute:-
provide the argument
api_hub_instanceon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
ApiHubInstance resource - The name of the Api Hub instance to retrieve. Format:
- 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
apihub/v1API. The full documentation for this API can be found at: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. This variant is also available:
gcloud apihub api-hub-instances describe
gcloud alpha apihub api-hub-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-02-24 UTC.