SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsvolcengine-rds-postgresql

volcengine-rds-postgresql

Deployment & operations

View repository

Updated 10-15 17:31

About this skill

Skill Overview

This Skill is used in conversations as an intelligent O&M agent for Volcengine RDS PostgreSQL:

  • Understand the user's natural language requirements(in Chinese or English), and identify whether they are related to RDS PostgreSQL;
  • Directly call the built-in script scripts/call_rds_postgresql.py to query RDS PostgreSQL in real time and obtain results;
  • When results are obtained or the user pastes error information,further explain, diagnose, and provide follow-up suggestions。

Working Mode:

  • Use the scripts/call_rds_postgresql.py script to directly obtain real-time responses from RDS PostgreSQL

How to Run: The script supports two ways to run:

# 方式 1: 使用 uv (推荐，自动管理依赖)
uv run ./scripts/call_rds_postgresql.py [action] [options]
Method 2: Use python (dependencies must be installed in advance)

python ./scripts/call_rds_postgresql.py [action] [options]


## 标准使用流程

1. **确认任务类型与参数**
    - 判断用户意图:查询实例列表、查看实例详情、管理数据库、管理账号、查看参数配置、创建实例等。
    - 收集必要参数(如未指定则使用默认值):
        - `--region`:地域 ID(默认 `cn-beijing`)
        - `--action`:操作类型(如 `list-instances`、`describe-instance`、`list-databases` 等)
        - `--instance-id`:实例 ID(部分操作必需)

2. **构造查询并调用脚本**
   - 示例（以下命令可使用 `uv run` 或 `python` 运行）:
     ```bash
     # 查询实例列表
     uv run ./scripts/call_rds_postgresql.py list-instances
     # 或
     python ./scripts/call_rds_postgresql.py list-instances

     # 查询指定实例详情
     uv run ./scripts/call_rds_postgresql.py describe-instance --instance-id postgres-xxx
     # 或
     python ./scripts/call_rds_postgresql.py describe-instance --instance-id postgres-xxx

     # 查询实例的数据库列表
     uv run ./scripts/call_rds_postgresql.py list-databases --instance-id postgres-xxx
     # 或
     python ./scripts/call_rds_postgresql.py list-databases --instance-id postgres-xxx

     # 查询实例的账号列表
     uv run ./scripts/call_rds_postgresql.py list-accounts --instance-id postgres-xxx
     # 或
     python ./scripts/call_rds_postgresql.py list-accounts --instance-id postgres-xxx

     # 查询实例参数
     uv run ./scripts/call_rds_postgresql.py list-parameters --instance-id postgres-xxx
     # 或
     python ./scripts/call_rds_postgresql.py list-parameters --instance-id postgres-xxx

     # 查询 VPC 列表（用于创建实例）
     uv run ./scripts/call_rds_postgresql.py list-vpcs
     # 或
     python ./scripts/call_rds_postgresql.py list-vpcs

     # 查询子网列表
     uv run ./scripts/call_rds_postgresql.py list-subnets --vpc-id vpc-xxx --zone-id cn-beijing-a
     # 或
     python ./scripts/call_rds_postgresql.py list-subnets --vpc-id vpc-xxx --zone-id cn-beijing-a
     ```

3. **解析结果并后续处理**
    - 将 RDS PostgreSQL 的响应用自然语言解释给用户;
    - 如返回包含敏感操作,评估风险并提醒:
        - 避免在生产环境直接执行高风险操作(如删除实例、删除数据库等);
        - 建议在测试环境验证或做好备份。

## 工具脚本使用说明

### 支持的操作(Actions)

| 操作 | 说明 | 必需参数 |
|------|------|----------|
| `list-instances` | 查询 RDS PostgreSQL 实例列表 | 无 |
| `describe-instance` | 查询指定实例详情 | `--instance-id` |
| `list-databases` | 查询实例的数据库列表 | `--instance-id` |
| `list-accounts` | 查询实例的账号列表 | `--instance-id` |
| `list-parameters` | 查询实例的参数配置 | `--instance-id` |
| `list-parameter-templates` | 查询参数模板列表 | 无 |
| `describe-parameter-template` | 查询参数模板详情 | `--template-id` |
| `list-vpcs` | 查询 VPC 列表 | 无 |
| `list-subnets` | 查询子网列表 | `--vpc-id` |
| `get-price` | 查询实例价格 | 多个配置参数 |

### 命令行参数

| 参数 | 说明 | 默认值 |
|------|------|--------|
| `action` | 操作类型(必需) | - |
| `--region` / `-r` | 火山引擎地域 ID | `cn-beijing` |
| `--instance-id` / `-i` | 实例 ID | 无 |
| `--page-number` | 分页页码 | `1` |
| `--page-size` | 每页记录数 | `10` |
| `--output` / `-o` | 输出格式(json/table) | `json` |

> **注意**：`--region`、`--page-number`、`--page-size` 等全局参数必须放在子命令**之前**，例如：
> ```bash
> uv run ./scripts/call_rds_postgresql.py --region cn-shanghai list-instances
> ```
> 放在子命令之后会被忽略（argparse 解析限制）。

### 输出格式

脚本会将查询信息输出到 `stderr`,将结果输出到 `stdout`,便于分离日志和结果:
[Operation] list-instances [Region] cn-beijing

[Query Result] <actual result content>


## 常见使用场景

### 1. 查看所有实例
```bash
uv run ./scripts/call_rds_postgresql.py list-instances

2. View instance details

uv run ./scripts/call_rds_postgresql.py describe-instance --instance-id postgres-xxx

3. View the instance's databases

uv run ./scripts/call_rds_postgresql.py list-databases --instance-id postgres-xxx

4. View the instance's accounts

uv run ./scripts/call_rds_postgresql.py list-accounts --instance-id postgres-xxx

5. View instance parameter configuration

uv run ./scripts/call_rds_postgresql.py list-parameters --instance-id postgres-xxx

6. Filter instances by version

uv run ./scripts/call_rds_postgresql.py list-instances --db-engine-version PostgreSQL_14

7. Query network information before creating an instance

# 先查询 VPC
uv run ./scripts/call_rds_postgresql.py list-vpcs

# 再查询子网
uv run ./scripts/call_rds_postgresql.py list-subnets --vpc-id vpc-xxx --zone-id cn-beijing-a

Environment Variable Configuration

  1. Obtain Volcengine access credentials: refer to the User Guide to obtain the AK/SK

  2. Configure the following environment variables:

export VOLCENGINE_ACCESS_KEY="your-access-key"
export VOLCENGINE_SECRET_KEY="your-secret-key"
export VOLCENGINE_REGION="cn-beijing"  # 可选，默认 cn-beijing

Permission Description：list-vpcs and list-subnets call the VPC service API. The AK/SK needs to be granted permissions for both RDS PostgreSQL and VPC（vpc:DescribeVpcs、vpc:DescribeSubnets) services at the same time, otherwise it will return a AccessDenied 403 error.