跳到主要内容

通用云 API 调用

v3.0.0+

tcb api 命令自 v3.0.0 起提供。

tcb api 提供了一个通用的腾讯云 API 调用入口，可以直接在命令行中调用任意腾讯云 API 接口，无需手动处理鉴权和请求封装。

基本用法​

tcb api <service> <action> [options]

参数说明：

参数说明必填
<service>腾讯云服务名称，如 tcb、scf、cls是
<action>API Action 名称，如 DescribeEnvs是
--body <json>请求体，JSON 字符串否
--version <version>API 版本号，如 2019-09-24（可选，不填时使用服务默认版本）否
-e, --env-id <envId>云开发环境 ID否
--json以 JSON 格式输出结果否

使用示例​

# 查询所有云开发环境
tcb api tcb DescribeEnvs

# 查询指定环境
tcb api tcb DescribeEnvs --body '{"EnvId":"my-env-id"}'

# 查询云函数列表（需指定环境）
tcb api scf ListFunctions -e my-env-id

# 指定 API 版本
tcb api tcb DescribeEnvs --version 2019-09-24

# 以 JSON 格式输出（适合脚本处理）
tcb api tcb DescribeEnvs --json

如何查找 service 和 action？​

  • 腾讯云 API 文档：https://cloud.tencent.com/document/api
    • service 对应各产品的接口域名前缀，如 tcb（云开发）、scf（云函数）、cls（日志服务）
    • action 对应具体接口名，如 DescribeEnvs、ListFunctions
提示

tcb api 使用当前已登录账号的凭证进行鉴权，无需额外配置密钥。调用前请确保已执行 tcb login。

命令速查​

命令说明
tcb api <service> <action>调用腾讯云 API
tcb api <service> <action> --body <json>携带请求体调用
tcb api <service> <action> --jsonJSON 格式输出