Back to Genai Toolbox

alloydb-get-instance

docs/en/integrations/alloydb-admin/tools/alloydb-get-instance.md

1.1.01.4 KB
Original Source

About

The alloydb-get-instance tool retrieves detailed information for a single, specified AlloyDB instance.

ParameterTypeDescriptionRequired
projectstringThe GCP project ID to get instance for.Yes
locationstringThe location of the instance (e.g., 'us-central1').Yes
clusterstringThe ID of the cluster.Yes
instancestringThe ID of the instance to retrieve.Yes

Compatible Sources

{{< compatible-sources >}}

Example

yaml
kind: tool
name: get_specific_instance
type: alloydb-get-instance
source: my-alloydb-admin-source
description: Use this tool to retrieve details for a specific AlloyDB instance.

Reference

fieldtyperequireddescription
typestringtrueMust be alloydb-get-instance.
sourcestringtrueThe name of an alloydb-admin source.
descriptionstringfalseDescription of the tool that is passed to the agent.