alloydb-get-instance Tool
The “alloydb-get-instance” tool retrieves details for a specific AlloyDB instance.
less than a minute
About
The alloydb-get-instance tool retrieves detailed information for a single,
specified AlloyDB instance.
| Parameter | Type | Description | Required |
|---|---|---|---|
project | string | The GCP project ID to get instance for. | Yes |
location | string | The location of the instance (e.g., ‘us-central1’). | Yes |
cluster | string | The ID of the cluster. | Yes |
instance | string | The ID of the instance to retrieve. | Yes |
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| AlloyDB Admin Source |
Example
kind: tools
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
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be alloydb-get-instance. |
| source | string | true | The name of an alloydb-admin source. |
| description | string | false | Description of the tool that is passed to the agent. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.