概述

云开发 HTTP API 是一套通过 HTTP 协议访问云开发平台功能的接口，支持数据库、数据模型、用户认证、云函数、云托管、云存储、AI 等功能。

准备工作​

在开始之前，请确保您已完成以下准备：

1. 创建云开发环境：创建云开发环境
2. 安全配置：如果希望从 浏览器端 调用，请确保您的环境已配置 云开发平台/安全来源 来放通跨域调用
   • 本地开发示例：localhost:3000、127.0.0.1:3000
   • 生产环境示例：您的实际域名
   • 使用在线调试工具：docs.cloudbase.net

⚠️ 注意：浏览器端调用必须配置安全来源，否则会因跨域限制导致请求失败。

认证和授权​

调用云开发 HTTP API 需要进行认证和授权。请根据您的应用场景选择合适的认证方式：

调用地址​

云开发 HTTP API 使用统一的域名供 API 调用，调用域名根据环境所属地域不同而有所不同。

国内地域​

环境所属地域为上海（ap-shanghai）等国内地域时，使用如下域名：

https://{your-env}.api.tcloudbasegateway.com

{your-env} 替换为实际的环境 ID。例如环境 ID 为 cloud1-abc，调用地址为：

https://cloud1-abc.api.tcloudbasegateway.com

海外地域​

环境所属地域为新加坡（ap-singapore）等海外地域时，使用如下域名：

https://{your-env}.api.intl.tcloudbasegateway.com

{your-env} 替换为实际的环境 ID。例如环境 ID 为 cloud1-abc，调用地址为：

https://cloud1-abc.api.intl.tcloudbasegateway.com

使用示例​

云函数调用示例​

以下示例展示如何通过 HTTP API 调用云函数：

curl -X POST "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME" \
  -H "Authorization: Bearer <access_token/apikey/publishable_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "张三",
    "age": 25
  }'

const response = await fetch(
  "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer <access_token/apikey/publishable_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "张三",
      age: 25,
    }),
  }
);

const result = await response.json();
console.log("函数返回结果:", result);

import requests
import json

def call_cloud_function():
    url = "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME"
    headers = {
        "Authorization": "Bearer <access_token/apikey/publishable_key>",
        "Content-Type": "application/json"
    }
    data = json.dumps({
        "name": "张三",
        "age": 25
    })

    response = requests.post(url, headers=headers, data=data)
    result = response.json()
    print("函数返回结果:", result)
    return result

成功调用云函数时，API 会返回以下格式的响应：

{
  "result": "函数执行结果",
  "requestId": "请求ID",
  "timestamp": 1640995200000
}

如果调用失败，错误响应格式如下：

{
  "code": "FUNCTIONS_PARAM_INVALID",
  "message": "参数错误详细信息",
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

在线调试工具​

云开发平台提供了 在线调试工具，您可以在不编写代码的情况下测试 API 接口：

1. 访问接口文档页面
2. 找到调试工具入口
3. 填写环境 ID 和请求参数
4. 点击发送请求查看响应