MCP Tools Reference: cloud-sql

工具：list_instances

列出專案中的所有 Cloud SQL 執行個體。

以下範例示範如何使用 curl 叫用 list_instances MCP 工具。

Curl 要求 
                  
curl --location 'https://sqladmin.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_instances",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

輸入內容的結構定義

執行個體清單要求。

SqlInstancesListRequest

JSON 表示法 
{
  "filter": string,
  "maxResults": integer,
  "pageToken": string,
  "project": string
}
欄位
filter

string

篩選運算式會篩選回應中列出的資源。運算式格式為 field:value。例如「instanceType:CLOUD_SQL_INSTANCE」。您可以視需要根據 JSON 表示法巢狀排列欄位，例如「settings.userLabels.auto_start:true」。

多個篩選查詢以空格分隔。舉例來說，'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'。根據預設，每個運算式都是 AND 運算式。不過，您可以明確加入 AND 和 OR 運算式。
maxResults

integer (uint32 format)

要傳回的執行個體數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 500 個執行個體。許可的最大值為 1000；超出的數值將一律指定為 1000。
pageToken

string

先前傳回的網頁權杖，代表要查看的較大結果集部分。
project

string

要列出 Cloud SQL 執行個體的專案 ID。

輸出內容的結構定義

MCP 的執行個體清單回應。

SqlInstancesListMcpResponse

JSON 表示法 
{
  "kind": string,
  "warnings": [
    {
      object (ApiWarning)
    }
  ],
  "items": [
    {
      object (McpDatabaseInstance)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

這項值一律為 sql#instancesList。
warnings[]

object (ApiWarning)

處理要求時發生的警告清單。
items[]

object (McpDatabaseInstance)

MCP 執行個體資源清單。
nextPageToken

string

用於逐頁瀏覽大型結果集的接續憑證。在後續要求中提供這個值，以傳回下一頁的結果。

ApiWarning

JSON 表示法 
{
  "code": enum (SqlApiWarningCode),
  "message": string,
  "region": string
}
欄位
code

enum (SqlApiWarningCode)

可明確識別警告類型的代碼。
message

string

警告訊息。
region

string

REGION_UNREACHABLE 警告的區域名稱。

McpDatabaseInstance

JSON 表示法 
{
  "project": string,
  "name": string,
  "databaseVersion": string,
  "region": string,
  "edition": string,
  "tier": string,
  "dataDiskSizeGb": string,
  "availabilityType": string,
  "tags": {
    string: string,
    ...
  },
  "state": enum (SqlInstanceState)
}
欄位
project

string

這是必要旗標，要列出 Cloud SQL 執行個體的專案 ID。
name

string

這是必要旗標，Cloud SQL 執行個體的名稱。這不包括專案 ID。
databaseVersion

string
region

string

選用。Cloud SQL 執行個體所在的地理區域。例如 us-central1、europe-west1 和 asia-east1。
edition

string

選用。執行個體版本，可以是 ENTERPRISE 或 ENTERPRISE_PLUS。
tier

string

選用。這個執行個體的層級 (或機器類型)。
dataDiskSizeGb

string (Int64Value format)

選用。資料磁碟大小 (以 GB 為單位)。預設值為 100。
availabilityType

string

選用。供應量類型。可能的值：* ZONAL：執行個體只會從一個區域提供資料。該區域的服務中斷會影響資料存取權。這是預設值。* REGIONAL：執行個體可從區域內的多個可用區提供資料 (高可用性)。
tags

map (key: string, value: string)

選用。僅限輸入。繫結至這個執行個體的標記鍵和標記值。

包含 "key": value 組合清單的物件，例如 { "name": "wrench", "mass": "1.3kg", "count": "3" }。
state

enum (SqlInstanceState)

僅供輸出。Cloud SQL 執行個體的狀態。

Int64Value

JSON 表示法 
{
  "value": string
}
欄位
value

string (int64 format)

int64 值。

TagsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
欄位
key

string
value

string

工具註解

破壞性提示：❌ | 等冪提示：❌ | 唯讀提示：✅ | 開放世界提示：❌