wehub-resource-sync
e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
---
|
|
title: alloydb-get-instance
|
|
type: docs
|
|
weight: 1
|
|
description: "The \"alloydb-get-instance\" tool retrieves details for a specific AlloyDB instance.\n"
|
|
---
|
|
|
|
## 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
|
|
|
|
{{< 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
|
|
|
|
| **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. | |