| name | tcapi |
| display_name | 腾讯云 API 助手 |
| description | Skill to call Cloud API for Tencent Cloud (腾讯云). Used for cloud automation or resource management. 当用户需要查询、创建、管理腾讯云资源,或执行云 API 自动化操作时触发。 |
| version | 1.0.0 |
| tags | ["tccli","cloud-api","tencent-cloud","automation"] |
| keywords | ["腾讯云","tccli","cloud api","云资源","云管理","自动化运维"] |
| prompt_template | 对 {service} 产品执行 {action} 操作 |
| examples | ["查询广州地域的 CVM 实例","创建一台按量计费的云服务器","查看 COS 存储桶列表"] |
腾讯云 API 助手
统一使用 tccli 命令行工具调用腾讯云 API,实现云资源的查询、创建、修改、删除等操作。
适用场景
- 云资源查询与管理(CVM / COS / CBS / VPC / TKE 等 200+ 产品)
- 自动化运维(批量操作、定时任务、脚本编排)
- 云 API 接口探索与文档检索
不适用场景
- 不支持 Terraform / Pulumi 等 IaC 编排工具
- 不做多云管理(仅限腾讯云)
- 不做费用充值、账号注册等非 API 操作
前置条件
核心原则
- 优先检索最佳实践 → 再查接口文档 → 最后调用 API。不要跳过文档检索直接调用,避免用错接口或遗漏参数。
- 在线文档是实时态,本地 tccli 是版本快照。以在线文档(
cloudcache.tencentcs.com)为准判断接口/参数是否存在;本地 tccli 因版本差异,可能缺少新接口、或残留已下线的旧接口。遇到本地报「无此接口」或服务端报「接口已下线」时,先查在线文档确认真实情况,再决定升级 tccli 或换用替代接口。
执行流程
Step 0:环境自检(首次任务必做,一次探测串起所有分支)
在真正调用业务接口前,先做一次探测,把环境状态判定清楚,避免中途反复失败:
command -v tccli >/dev/null 2>&1 && tccli cvm DescribeRegions >/dev/null 2>&1 && echo "TCCLI_OK" || echo "TCCLI_NEED_CHECK"
判定分支:
| 探测结果 | 状态 | 处理 |
|---|
返回 TCCLI_OK | 已安装、可运行、凭证有效 | 直接进入 Step 1 |
command not found | 未安装 | 引导安装(references/install.md);若已装 Python 也可直接用 Step 5 兼容模式 |
bad interpreter / No module named tccli | 装了但 shebang/环境坏 | 切换 Step 5 兼容模式(动态探测 Python 调用),本会话后续统一使用 |
报 secretId is invalid / AuthFailure.SecretIdNotFound | 凭证缺失 | 进入 Step 2 配置凭证 |
探测通过(TCCLI_OK)后,本会话无需再重复自检,直接调用即可。
Step 1:检索 API 文档
调用前先通过 curl + grep 检索业务、接口、最佳实践、数据结构。参考 references/refs.md 获取完整检索方式。
1.1 发现业务
检索 tccli 服务名(如 cvm、cbs):
curl -s https://cloudcache.tencentcs.com/capi/refs/services.md | grep 云服务器
参考输出:
[cvm](service/cvm/index.md) | 云服务器 | 2017-03-12 | ...
1.2 发现最佳实践
优先检索是否有匹配当前场景的最佳实践:
curl -s https://cloudcache.tencentcs.com/capi/refs/service/cvm/practices.md | grep 重装
1.3 检索接口
若最佳实践未覆盖,在业务接口列表中检索(接口名即 tccli 的 <Action>):
curl -s https://cloudcache.tencentcs.com/capi/refs/service/cvm/actions.md | grep "扩容\|磁盘"
1.4 阅读接口文档
获取参数说明和支持的地域信息:
curl -s https://cloudcache.tencentcs.com/capi/refs/service/cvm/action/ResizeInstanceDisks.md
1.5 阅读数据结构
文档中涉及的数据结构可进一步查看:
curl -s https://cloudcache.tencentcs.com/capi/refs/service/cvm/model/SystemDisk.md
Step 2:凭证配置
如果已经提供了凭证,tccli 可以正常调用。
如缺少凭证,执行 tccli 会提示 "secretId is invalid"(错误码 AuthFailure.SecretIdNotFound)。此时不要直接假设 tccli auth login 可用——auth login(浏览器 OAuth)是较新版本才有的子命令,旧版 tccli 没有 auth 子命令,硬跑会报 invalid choice: 'auth'。
必须先探测能力,再选路径:
tccli auth login --help >/dev/null 2>&1 && echo "AUTH_LOGIN_OK" || echo "AUTH_LOGIN_UNSUPPORTED"
AUTH_LOGIN_OK(新版)→ 执行 tccli auth login 进行浏览器授权登录,等待回调后继续(命令会起本地端口、阻塞进程,直到浏览器 OAuth 完成并回调)。
AUTH_LOGIN_UNSUPPORTED(旧版)→ 引导用户二选一:① 升级 pip install -U tccli 后即可用浏览器登录;② 由用户在自己终端执行 tccli configure 交互式填入密钥。Agent 不代填、不索要、不打印密钥。
完整的能力探测流程、双路径细节与多账户用法,参考 references/auth.md。
安全红线:严禁向用户索要 SecretId/SecretKey,也拒绝任何有可能打印凭证的操作(尤其是 tccli configure list)。
Step 3:调用 API
基本形式:
tccli <service> <Action> [--param value ...] [--region <地域>]
输入参数:
| 参数 | 类型 | 必填 | 说明 |
|---|
service | string | 是 | 产品标识,如 cvm、cbs、vpc。通过 Step 1.1 检索获取 |
Action | string | 是 | 接口名,如 DescribeInstances、RunInstances。通过 Step 1.3 检索获取 |
--region | string | 视接口 | 地域,如 ap-guangzhou。多数产品必传;全局接口(cam、account、dnspod、domain、ssl、ba、tag)可省略 |
--param value | 各类型 | 视接口 | 接口参数,简单类型直接传值,复杂类型传 JSON 字符串 |
常用示例 —— 查询 CVM 地域:
tccli cvm DescribeRegions
查询实例(需指定地域):
tccli cvm DescribeInstances --region ap-guangzhou
参数规则:
输出格式:tccli 返回标准 JSON,包含 Response 字段。示例:
{
"Response": {
"TotalCount": 1,
"InstanceSet": [{"InstanceId": "ins-xxx", "InstanceName": "test", ...}],
"RequestId": "eac6b301-..."
}
}
空结果输出:查询无匹配时,列表字段返回空数组,计数字段为 0:
{
"Response": {
"TotalCount": 0,
"InstanceSet": [],
"RequestId": "eac6b301-..."
}
}
效率约束:腾讯云 API 默认限频为 10 次/秒(部分接口更低),批量操作时需控制调用频率,避免触发 RequestLimitExceeded。建议串行调用或加间隔,不要并发轰炸。
避免并行调用:tccli 当前并行调用存在配置文件竞争问题,会导致响应失败。当前请逐个接口调用。
Step 4:异常处理
调用失败时,tccli 会返回包含 Error 字段的 JSON:
{
"Response": {
"Error": { "Code": "AuthFailure.SecretIdNotFound", "Message": "secretId is invalid" },
"RequestId": "xxx"
}
}
常见错误及处理:
| 错误码 | 含义 | 处理方式 |
|---|
AuthFailure.SecretIdNotFound | 凭证缺失或无效 | 先探测 tccli auth login --help:支持则 tccli auth login;不支持(旧版)则升级 pip install -U tccli 或引导用户 tccli configure(详见 Step 2 / references/auth.md) |
AuthFailure.UnauthorizedOperation | 无权限 | 检查 CAM 策略,确认子账号有该接口权限 |
InvalidParameterValue | 参数值不合法 | 查阅接口文档确认参数取值范围 |
ResourceNotFound | 资源不存在 | 确认资源 ID 和地域是否正确 |
RequestLimitExceeded | 请求频率超限 | 等待后重试,或减少并发调用频率 |
UnsupportedOperation / DeprecatedOperation / InvalidAction | 接口已下线/更名,或本地版本认得但云端已淘汰 | 检索在线文档确认现行接口,改用替代接口;勿死磕旧接口 |
本地 invalid choice: 'XxxAction' / argparse 报错,非服务端返回 | 旧版 tccli 本地缺少该新接口(发布快照落后于云端) | 引导 pip install -U tccli 升级;或先查在线文档确认接口存在后再操作 |
DryRunOperation | DryRun 操作成功 | 非真实错误,表示参数校验通过 |
UnsupportedRegion | 不支持的地域 | 查阅接口文档确认支持的地域列表 |
ResourceInsufficient | 资源不足 | 换可用区或调整规格重试 |
| 网络超时 / 连接失败 | 网络不通 | 检查网络连通性,确认是否需要代理 |
Step 5:tccli 不可用时的兜底方案
当直接执行 tccli 报错 bad interpreter、No module named tccli 或 command not found 时,通常是 tccli 的 shebang 指向了已卸载的 Python 解释器(环境问题,并非每个用户都会遇到)。此时动态探测一个可用的 Python 解释器及其 site-packages 后再调用,不要硬编码任何平台特定路径:
PY=$(command -v python3 || command -v python)
SITE=$("$PY" -c "import site,sys; print(next((p for p in site.getsitepackages()+[site.getusersitepackages()] ), ''))")
PYTHONPATH="$SITE" "$PY" -c "
import sys
sys.argv = ['tccli', 'cvm', 'DescribeInstances', '--region', 'ap-guangzhou']
from tccli.main import main
main()
"
要点:
- 用
command -v 探测当前环境真实可用的解释器,避免写死 /usr/local/bin/python3
- 用
site.getsitepackages() 动态获取包目录,避免写死 python3.12 等版本号
- 通过
sys.argv 传参,替换示例中的 service / Action / 参数即可
- 若 shebang 正常(直接
tccli 可用),无需本兜底,直接调用即可
数据边界与安全声明
- 本 SKILL 只执行用户明确指定的 API 调用,不会自动执行未经确认的写操作
- tccli 参数由用户指定或从接口文档获取,SKILL 不对参数做二次拼接或动态生成,避免注入风险
- tccli 调用受腾讯云 CAM 权限策略约束,SKILL 不具备超出用户权限的能力
- tccli 输出为 JSON 数据,应作为数据解读,不应作为 shell 命令执行
- API 文档检索地址
cloudcache.tencentcs.com 为腾讯云官方文档缓存,内容可信