SuperAPI AI 工具集

volcengine-api

编程与开发

查看项目

更新于 10-16 01:24

技能介绍

用途:面向火山引擎 API 的查询助手,帮助用户查找 API、理解参数与响应结构、排查错误码,数据来自官方 API Explorer,实时获取而非依赖记忆。

主要能力:

  1. 查找 API:用自然语言搜索接口,返回 Action、ServiceCode、中文名、版本等。
  2. 查询参数:列出必填/可选参数、类型、枚举值、默认值及条件依赖(条件必填、互斥、取值约束)。
  3. 响应结构:给出字段、类型、枚举取值与嵌套结构。
  4. 分页:识别 MaxResults+NextToken 或 PageSize+PageNumber 模式。
  5. 错误码:查询错误含义、常见原因与排查建议。
  6. 浏览服务能力与比较 API。

使用方式(关键接口):

  • 服务列表:GET https://api.volcengine.com/api/common/explorer/services
  • 版本列表:GET https://api.volcengine.com/api/common/explorer/versions?ServiceCode={ServiceCode}
  • API 列表:GET https://api.volcengine.com/api/common/explorer/apis?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version}
  • API 详情(Swagger):GET https://api.volcengine.com/api/common/explorer/api-swagger?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version}&ActionName={ActionName}
  • 搜索:GET https://api.volcengine.com/api/common/search/all?Query={keyword}&Channel=api
  • 错误码搜索:GET https://api.volcengine.com/api/common/search/all?Query={error_code}&Channel=error_code

适用场景:查接口、看参数与枚举、核对响应字段、排查报错、对比接口、了解某服务提供哪些 API。

限制:版本优先取 IsDefault=1,否则取最新;同一错误码在不同 API 含义可能不同,缺少上下文时需用户补充;需要可运行 SDK 代码或 CLI 操作时应转用相应技能;网络错误时提示重试。