← Back to Skills Marketplace
volc-sdk-team

Volcengine Troubleshooting

by sdk-team · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ⚠ suspicious
35
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install volcengine-troubleshooting
Description
Use when the user encounters VolcEngine errors or needs local troubleshooting for OpenAPI, Python SDK, CLI, IAM, billing, compute, networking, storage, datab...
README (SKILL.md)

VolcEngine Troubleshooting

本 skill 面向用户本地环境使用,目标是在不修改云上资源的前提下,帮助定位 VolcEngine 产品、OpenAPI、Python SDK、ve/tosutil CLI 和控制台操作失败的原因。主入口只保留必要的启动规则、场景路由和安全边界;本地工具检查与完整领域索引放在 references/getting-started.md,OpenAPI 报错、签名、鉴权、参数、限流以及 ve/tosutil/Python SDK 调用链路的快速检查放在 references/openapi-quick-check.md,具体产品域手册放在 references/domain-guides/

开始前

  1. 先读取 references/getting-started.md,确认本地工具、环境变量、场景依赖和领域路由。

  2. 如用户允许执行本地体检,运行通用检查:

    bash skills/volcengine-troubleshooting/scripts/common_check.sh
    
  3. 优先用 ve sts GetCallerIdentity 验证当前身份链路,只报告是否可用和必要的身份摘要,不输出 SecretKey、SessionToken、完整 AccessKeyId、完整手机号、账单明细或对象内容。

  4. 不要运行 ve configure、登录/SSO 初始化、安装依赖、写入配置文件或修改云资源,除非用户明确要求并确认影响。

  5. 若不确定归属,按 references/getting-started.md 中的“场景路由”定位领域;遇到 OpenAPI 报错、签名/鉴权失败、参数校验、限流、服务端错误,或由 ve/tosutil/Python SDK 暴露出的 OpenAPI 调用失败,先读 references/openapi-quick-check.md 收敛 RequestId、Action、Region、错误码和最小复现上下文。

  6. 根据下方路由打开对应 references/domain-guides/\x3Cdomain>/README.md,再按领域手册的“先读这些”读取 query-cli-catalog.md、章节 README、api-coverage-matrix.md 和脚本 README。

场景路由

先从用户报错中提取 RequestIdErrorCodeActionServiceRegion、资源 ID、发生时间和调用方式。如果缺失,先问最少必要问题。

领域判断优先读 references/getting-started.md。确定领域后,再进入对应 references/domain-guides/\x3Cdomain>/README.md

  • openapi-sdk-cli:OpenAPI、ve CLI、Python SDK、签名、API 网关。
  • account-permission:账号、AK/SK、STS、IAM、角色、权限不足。
  • billing-quota:账单、余额、欠费、订单、配额、资源包。
  • compute-container-network:ECS、VKE、CLB/ALB、VPC、NAT、EIP、路由、安全组。
  • storage-database:TOS、EBS、文件存储、云备份、RDS、Redis、数据库连接。
  • domain-cdn-ingress:DNS、域名、证书、CDN/DCDN、入口回源。
  • communication-media:SMS、RTC、VOD、Live、CV/OCR、veImageX。
  • llm-ecosystem:Ark、豆包、VikingDB、AgentKit、ArkClaw、Coze、机器学习平台。
  • security-kms-encryption:KMS、Secret、云加密机、WAF、DDoS、Cloud Firewall、安全中心。

仍无法分类时,完成 scripts/common_check.sh 后,按报错中的服务名查 ve SERVICE --helpve SERVICE ACTION --help

核心原则

  • 只读优先:默认只执行 Describe/List/Get/Query/Lookup/Check 类命令。Create/Update/Delete/Attach/Detach/Put/Set/Start/Stop/Run/Invoke/Pay/Renew/Refresh/Preload 等写操作必须先解释影响并等待用户确认。
  • CLI 优先,SDK 辅助:只支持 vetosutil 两类 CLI。只有分页聚合、跨资源拓扑、日志归并或 CLI 未覆盖时,才建议 volc-sdk-pythonvolcengine-python-sdk 脚本。
  • 凭证安全:只从环境变量读取 AK/SK/Token;不要要求用户把凭证写入文件;不要打印 SecretKey、SessionToken 或完整 AccessKeyId;展示 AK 时至少遮蔽中间部分。
  • 最小上下文:每次排障只收集当前问题所需的服务、地域、资源和时间窗口。不要批量枚举无关账号资源。
  • 解释判据:每个检查都说明为什么查、期望看到什么、异常意味着什么,以及下一步该收集哪一项证据。
Usage Guidance
Install only if you are comfortable with a troubleshooting assistant using VolcEngine credentials. Use a least-privilege, temporary account where possible, do not grant secret-value or token-minting permissions unless explicitly needed, and require manual approval before any command that could reveal API keys, role credentials, workload tokens, SecretValue, user data, or full console output.
Capability Tags
cryptorequires-oauth-tokenrequires-sensitive-credentials
Capability Assessment
Purpose & Capability
The stated purpose is coherent cloud troubleshooting, and most guidance is read-only, but API matrices include actions such as GetSecretValue, GetResourceApiKey, GetRoleCredentials, GetUserCredential, and workload access token retrieval as troubleshooting candidates.
Instruction Scope
Top-level instructions warn not to print credentials and some domain guides require confirmation for sensitive reads, but the coverage matrices repeatedly classify secret-returning calls under read-only or diagnostic scope, which can confuse agent behavior.
Install Mechanism
No risky install behavior was found; the artifact is mostly markdown plus local scripts, with no automatic package install, persistence setup, or configuration writing.
Credentials
VolcEngine credentials and CLI/API access are expected for this troubleshooting purpose, but users should restrict them to least-privilege diagnostic permissions because the skill covers many cloud product areas.
Persistence & Privilege
The skill instructs agents not to run ve configure/login/SSO or write credentials, and inspected scripts read credentials from environment variables without creating persistence or modifying cloud resources.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install volcengine-troubleshooting
  3. After installation, invoke the skill by name or use /volcengine-troubleshooting
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of volcengine-troubleshooting. - Assists with VolcEngine error troubleshooting across OpenAPI, Python SDK, CLI, IAM, billing, compute, networking, storage, database, CDN, media, AI, security, and VKE scenarios. - Focuses strictly on local, non-destructive checks—does not modify cloud resources by default. - Provides domain-specific routing, quick OpenAPI and authentication checks, and clear safety boundaries for credential handling. - CLI-based and read-only operations are prioritized; write operations require explicit user confirmation. - Guidance and references are organized for fast issue identification and resolution, with domain handbooks for detailed troubleshooting steps.
Metadata
Slug volcengine-troubleshooting
Version 1.0.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is Volcengine Troubleshooting?

Use when the user encounters VolcEngine errors or needs local troubleshooting for OpenAPI, Python SDK, CLI, IAM, billing, compute, networking, storage, datab... It is an AI Agent Skill for Claude Code / OpenClaw, with 35 downloads so far.

How do I install Volcengine Troubleshooting?

Run "/install volcengine-troubleshooting" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Volcengine Troubleshooting free?

Yes, Volcengine Troubleshooting is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Volcengine Troubleshooting support?

Volcengine Troubleshooting is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Volcengine Troubleshooting?

It is built and maintained by sdk-team (@volc-sdk-team); the current version is v1.0.0.

💬 Comments