Skip to content

alloydb-list-instances.md

Latest commit

 

History

History
45 lines (34 loc) · 2.01 KB

alloydb-list-instances.md

File metadata and controls

45 lines (34 loc) · 2.01 KB
title alloydb-list-instances
type docs
weight 1
description The "alloydb-list-instances" tool lists the AlloyDB instances for a given project, cluster and location.

About

The alloydb-list-instances tool retrieves AlloyDB instance information for all or specified clusters and locations in a given project.

alloydb-list-instances tool lists the detailed information of AlloyDB instances (instance name, type, IP address, state, configuration, etc) for a given project, cluster and location. The tool takes the following input parameters:

Parameter Type Description Required
project string The GCP project ID to list instances for. Yes
cluster string The ID of the cluster to list instances from. Use '-' to get results for all clusters. Default: -. No
location string The location of the cluster (e.g., 'us-central1'). Use '-' to get results for all locations. Default: -. No

Compatible Sources

{{< compatible-sources >}}

Example

kind: tools
name: list_instances
type: alloydb-list-instances
source: alloydb-admin-source
description: Use this tool to list all AlloyDB instances for a given project, cluster and location.

Reference

field type required description
type string true Must be alloydb-list-instances.
source string true The name of an alloydb-admin source.
description string false Description of the tool that is passed to the agent.