gcloud alpha apigee products describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha apigee products describe - describe an Apigee API product
- SYNOPSIS
gcloud alpha apigee products describe(PRODUCT:--organization=ORGANIZATION)[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Describe an Apigee API product.- EXAMPLES
- To describe an API product called
in the active Cloud Platformproject, run:product-namegcloudalphaapigeeproductsdescribeproduct-nameTo describe an API product called
in an Apigee organizationcalledother-product, run:org-namegcloudalphaapigeeproductsdescribeother-product--organization=org-nameTo describe an API product called
as a JSON object, run:product-namegcloudalphaapigeeproductsdescribeproduct-name--format=json - POSITIONAL ARGUMENTS
- API product resource - API product to be described. To get a list of availableAPI products, run:
gcloudalphaapigeeproductslistTheargumentsinthisgroupcanbeusedtospecifytheattributesofthisresource.This must be specified.
PRODUCT- ID of the API product or fully qualified identifier for the API product.
To set the
productattribute:- provide the argument
PRODUCTon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--organization=ORGANIZATION- Apigee organization containing the API product. If unspecified, the CloudPlatform project's associated organization will be used.
To set the
organizationattribute:- provide the argument
PRODUCTon the command line with a fullyspecified name; - provide the argument
--organizationon 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.
- provide the argument
- API product resource - API product to be described. To get a list of availableAPI products, run:
- 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
- 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. These variants are also available:
gcloudapigeeproductsdescribegcloudbetaapigeeproductsdescribe
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-07-22 UTC.