跳到主要内容

通用云 API 调用

v3.0.0+

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

tcb api 是通用云 API 入口，可以直接调用任意腾讯云 API 接口，鉴权和请求封装由 CLI 完成。

基本用法​

tcb api <service> <action> [options]

参数说明：

参数说明必填
<service>腾讯云服务名称，如 tcb、scf、cls是
<action>API Action 名称，如 DescribeEnvs是
--body <json>请求体，JSON 字符串否
--api-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 --api-version 2019-09-24

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

--body 必须是合法 JSON，格式错误时命令直接报错，不会发起请求。

查找 service 和 action​

在腾讯云 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 格式输出

注意事项​

  • 少数高危接口被内置黑名单拦截，例如 CynosDB 的账号密码重置、账号删除类 Action，该名单不可关闭
  • -e 只影响需要环境上下文的调用，不改变请求体的内容
  • 输出结构以腾讯云 API 原始响应为准，字段含义查对应接口文档