/byted-vedb-mysql

name: byted-vedb-mysql
description: 火山引擎 VEDBM（云数据库 VeDB MySQL 版）管理技能。当用户需要创建 VEDBM 实例、查询 VEDBM 实例列表、查看实例详情、管理数据库账号、获取实例连接地址（Endpoints）、或对实例规格进行升级/降级时使用此技能。包含特定关键词：火山引擎云数据库、VEDBM、VeDB MySQL。
version: 1.0.0
license: Apache-2.0
metadata:
  display_name: 火山引擎云数据库 VEDBM 管理工具
  version: 1.0.0
  permissions:
    - network
  env:
    - VOLCENGINE_ACCESS_KEY
    - VOLCENGINE_SECRET_KEY

火山引擎 VEDBM 管理技能

本技能用于管理火山引擎 VEDBM（云数据库）实例，包含以下功能：

1. **创建实例**：支持用户自定义实例规格，默认使用 2C8G 规格，用户名 root，密码随机生成 2. **查看实例列表**：查询指定地域下的所有 VEDBM 实例 3. **查看数据库账号列表**：查询指定实例中的所有数据库账号及其状态 4. **查看实例连接地址**：查询指定实例的连接地址信息（域名、端口、IP等）

✨ 新特性

• **智能规格匹配**：支持用户输入简单格式（如 "2c8g"、"4c16g"）
• **灵活默认值**：默认使用 2C8G 规格
• **自动降级/升级**：如果用户提供的规格不存在，自动选择最接近的可用规格

使用流程

第一步：收集必要信息

当用户触发此技能时，先检查是否有必要信息。如果没有，引导用户提供：

| 信息 | 必填 | 说明 | |------|------|------| | VPC ID | ✅ | 虚拟私有云 ID | | 子网 ID | ✅ | 子网 ID | | 可用区 ID | ✅ | 可用区（如 cn-guangzhou-a） | | AccessKey ID | ✅ | 火山引擎访问密钥 ID | | Secret Access Key | ✅ | 火山引擎秘密访问密钥 |

第二步：信息收集方式

方式 A：对话引导（推荐首次使用）

询问用户： > "好的，我来帮你创建 VEDBM 实例！需要你提供一些信息： > > 1. VPC ID 是什么？ > 2. 子网 ID 是什么？ > 3. 想用哪个可用区？（如 cn-guangzhou-a） > 4. AccessKey ID 是什么？ > 5. Secret Access Key 是什么？"

方式 B：环境变量配置（推荐频繁使用）

提示用户配置环境变量：

# 配置环境变量
export VOLCENGINE_ACCESS_KEY="你的AccessKeyId"
export VOLCENGINE_SECRET_KEY="你的SecretAccessKey"
export VEDBM_VPC_ID="你的VPC ID"
export VEDBM_SUBNET_ID="你的子网 ID"
export VEDBM_ZONE_ID="cn-guangzhou-a"

或者使用 `.env` 文件：

cd scripts
cp .env.example .env
# 编辑 .env 文件填入真实信息

第三步：执行创建

收集完信息后，执行创建命令。

访问密钥配置

方式 1：命令行参数

python scripts/create_vedbm_instance.py \
  --vpc-id <你的VPC ID> \
  --subnet-id <你的子网 ID> \
  --zone-id cn-guangzhou-a \
  --access-key-id <你的AccessKeyId> \
  --secret-access-key <你的SecretAccessKey>

方式 2：环境变量

export VOLCENGINE_ACCESS_KEY="your-access-key-id"
export VOLCENGINE_SECRET_KEY="your-secret-access-key"
export VEDBM_VPC_ID="your-vpc-id"
export VEDBM_SUBNET_ID="your-subnet-id"
export VEDBM_ZONE_ID="cn-guangzhou-a"

python scripts/create_vedbm_instance.py

方式 3：混合使用

可以部分用环境变量，部分用命令行参数：

export VOLCENGINE_ACCESS_KEY="your-access-key-id"
export VOLCENGINE_SECRET_KEY="your-secret-access-key"

python scripts/create_vedbm_instance.py \
  --vpc-id <你的VPC ID> \
  --subnet-id <你的子网 ID> \
  --zone-id cn-guangzhou-a

可用区说明

广州区域可用区：

• `cn-guangzhou-a` - 可用区 A
• `cn-guangzhou-c` - 可用区 C

**注意**：没有 `cn-guangzhou-b`

节点规格

| 规格 | CPU | 内存 | 说明 | |------|-----|------|------| | `vedb.mysql.x2.large` | 2核 | 8GB | **默认**，入门级 | | `vedb.mysql.x4.large` | 4核 | 16GB | 性价比高 | | `vedb.mysql.g4.large` | 4核 | 16GB | 通用型 | | `vedb.mysql.p4.large` | 4核 | 16GB | 性能型 | | `vedb.mysql.x4.xlarge` | 8核 | 32GB | 高性能 | | `vedb.mysql.x8.large` | 16核 | 64GB | 旗舰级 |

🎯 规格输入格式

支持多种输入格式：

1. 简写格式（推荐）

• `2c8g` - 2核8GB
• `4c16g` - 4核16GB
• `8c32g` - 8核32GB

2. 只指定 CPU

• `2c` - 自动匹配 2核 的规格
• `4c` - 自动匹配 4核 的规格

3. 只指定内存

• `8g` - 自动匹配 8GB 的规格
• `16g` - 自动匹配 16GB 的规格

4. 完整规格名

• `vedb.mysql.x2.large`
• `vedb.mysql.x4.large`

🤖 智能匹配规则

如果用户提供的规格不存在，系统会自动选择最接近的规格：

1. 优先选择大于等于目标配置的规格 2. CPU 权重 > 内存权重 3. 如果没有足够大的规格，选择最大的可用规格

**示例**：

• 用户输入 `3c10g` → 自动匹配 `4c16g`
• 用户输入 `5c20g` → 自动匹配 `8c32g`
• 用户输入 `1c4g` → 自动匹配 `2c8g`（最小规格）

前置条件

1. 已安装火山引擎 Python SDK：

   pip install volcengine-python-sdk

2. 已配置火山引擎访问凭证（Access Key ID 和 Secret Access Key）

使用方法

运行脚本创建实例：

python scripts/create_vedbm_instance.py

脚本参数

脚本支持以下可选参数：

• `--region`: 区域，默认 `cn-guangzhou`
• `--instance-name`: 实例名称，默认随机生成
• `--node-spec`: 节点规格（可选，默认 `2c8g`）
• 支持格式：`2c8g`、`4c16g`、`vedb.mysql.x2.large`
• `--vpc-id`: VPC ID（必须提供）
• `--subnet-id`: 子网 ID（必须提供）
• `--zone-id`: 可用区 ID（必须提供）

输出信息

创建成功后会返回：

• 实例 ID
• 连接地址
• 端口
• 用户名（root）
• 密码（随机生成）
• 使用的规格（含描述和代码）

示例

示例 1：使用默认规格（2c8g）

python scripts/create_vedbm_instance.py \
  --vpc-id vpc-123456 \
  --subnet-id subnet-123456 \
  --zone-id cn-guangzhou-a

示例 2：使用简写规格

python scripts/create_vedbm_instance.py \
  --vpc-id vpc-123456 \
  --subnet-id subnet-123456 \
  --zone-id cn-guangzhou-a \
  --node-spec 4c16g

示例 3：使用完整规格名

python scripts/create_vedbm_instance.py \
  --vpc-id vpc-123456 \
  --subnet-id subnet-123456 \
  --zone-id cn-guangzhou-a \
  --node-spec vedb.mysql.x4.large

示例 4：只指定 CPU

python scripts/create_vedbm_instance.py \
  --vpc-id vpc-123456 \
  --subnet-id subnet-123456 \
  --zone-id cn-guangzhou-a \
  --node-spec 8c

---

功能二：查看实例列表

使用流程

第一步：收集必要信息

当用户需要查看实例列表时，先检查是否有必要信息。如果没有，引导用户提供：

| 信息 | 必填 | 说明 | |------|------|------| | AccessKey ID | ✅ | 火山引擎访问密钥 ID | | Secret Access Key | ✅ | 火山引擎秘密访问密钥 | | 区域（可选） | ❌ | 查询的区域，默认 cn-guangzhou |

第二步：信息收集方式

方式 A：对话引导（推荐首次使用）

询问用户： > "好的，我来帮你查看 VEDBM 实例列表！需要你提供一些信息： > > 1. AccessKey ID 是什么？ > 2. Secret Access Key 是什么？ > 3. 要查询哪个区域？（默认 cn-guangzhou）"

方式 B：环境变量配置（推荐频繁使用）

提示用户配置环境变量（可以复用以创建实例的配置）：

# 配置环境变量
export VOLCENGINE_ACCESS_KEY="你的AccessKeyId"
export VOLCENGINE_SECRET_KEY="你的SecretAccessKey"
export VEDBM_REGION="cn-guangzhou"  # 可选

使用方法

运行脚本查询实例列表：

python scripts/list_instances.py

脚本参数

脚本支持以下参数：

• `--region`: 区域，默认 `cn-guangzhou`
• `--access-key-id`: 访问密钥 ID（或环境变量 VOLCENGINE_ACCESS_KEY）
• `--secret-access-key`: 秘密访问密钥（或环境变量 VOLCENGINE_SECRET_KEY）

输出信息

查询成功后会返回：

• 区域
• 实例总数
• 每个实例的详细信息：
• 实例 ID
• 实例名称
• 实例状态
• 节点规格
• 可用区
• 创建时间

示例

示例 1：使用默认区域（cn-guangzhou）

python scripts/list_instances.py

示例 2：指定区域

python scripts/list_instances.py --region cn-beijing

输出示例

====================================================================================================
✅ VEDBM 实例列表查询成功！
====================================================================================================
区域: cn-guangzhou
实例总数: 2

📋 实例列表：
----------------------------------------------------------------------------