gcloud alpha apigee environments describe

NAME
gcloud alpha apigee environments describe - describe an Apigee deployment environment
SYNOPSIS
gcloud alpha apigee environments describe(ENVIRONMENT :--organization=ORGANIZATION)[GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Describe an Apigee deployment environment.

gcloud alpha apigee environments describe shows metadata about anApigee environment.

EXAMPLES
To describe an environment calledmy-envfor the active Cloud Platform project, run:
gcloudalphaapigeeenvironmentsdescribemy-env

To describe an environment calledmy-env,in an organization calledmy-org, as a JSONobject, run:

gcloudalphaapigeeenvironmentsdescribemy-env--organization=my-org--format=json
POSITIONAL ARGUMENTS
Environment resource - Apigee environment to be described. To get a list ofavailable environments, rungcloud alpha apigeeenvironments list. The arguments in this group can be used to specifythe attributes of this resource.

This must be specified.

ENVIRONMENT
ID of the environment or fully qualified identifier for the environment.

To set theenvironment attribute:

  • provide the argumentENVIRONMENT on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--organization=ORGANIZATION
Apigee organization containing the environment. If unspecified, the CloudPlatform project's associated organization will be used.

To set theorganization attribute:

  • provide the argumentENVIRONMENT on the command line with a fullyspecified name;
  • provide the argument--organization on the command line;
  • set the property [project] or provide the argument [--project] on the commandline, using a Cloud Platform project with an associated Apigee organization.
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 help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudbetaapigeeenvironmentsdescribe

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-05-07 UTC.