> For the complete documentation index, see [llms.txt](https://ifanr.gitbook.io/baas-js-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ifanr.gitbook.io/baas-js-sdk/open-api/cloud-function.md). # 云函数 ## 触发云函数 `POST https://cloud.minapp.com/oserve/v1/cloud-function/job/` > **info** 推荐使用[发起一个云函数请求](#发起一个云函数请求)触发云函数。 **参数说明** Content-Type: `Content-Type: application/json` | 参数 | 类型 | 必填 | 说明 | | -------------- | ------ | -- | --------------------------------------------------------------------- | | function\_name | String | 是 | 云函数名 | | data | Object | 否 | 传递给云函数的参数 | | sync | Bool | 否 | 是否等待返回函数执行结果，默认为 true。同步与异步云函数有不同的超时时间，同步云函数为 5 秒，而异步云函数为 5 分钟（300 秒） | **返回参数说明** 在 sync 为 true 的情况下 | 参数 | 类型 | 描述 | | ----- | ------------- | ------------------------------ | | code | Number | code 为 0 时表示成功执行云函数，否则为执行云函数失败 | | data | 由云函数返回的数据类型决定 | 函数通过 callback 返回的数据 | | error | Object | 返回的错误信息，成功则返回空对象 | ## 测试云函数 **接口地址** `POST https://cloud.minapp.com/oserve/v1.3/cloud-function/:cloud_function_name/debug/` 其中 `:cloud_function_name` 是云函数的名字。 **参数说明** Content-Type: `Content-Type: application/json` | 参数 | 类型 | 必填 | 说明 | | ---------- | ------- | -- | ------------------------------------------------------------------------------------------------------------------ | | data | Object | 是 | 自定义数据，没有则需要提供一个空对象 | | subject | String | 否 | 触发类型，若不提供默认为 sdk, 可选值有：sdk, open\_api, cloud\_function, flex\_schema, wechat\_pay\_success, timer, file\_operation | | schema\_id | Integer | 否 | 表 ID，如果 subject 为 FlexSchema 则必填 | **返回参数** | 参数 | 类型 | 说明 | | --------------- | ------------- | ----------------------------------------- | | billing\_time | Integer | 计费时间 | | code | Integer | 函数调用正常：0，函数调用出错：1 | | data | 由云函数返回的数据类型决定 | 函数通过 callback 返回的数据 | | error | Object | 包含三个键，错误信息：message, 错误堆栈：stack, 错误类型：type | | execution\_time | Float | 执行时间，毫秒 | | job\_id | String | 任务 ID | | log | String | 日志 | | mem\_usage | Integer | 内存使用量，字节数 | **代码示例** ``` curl -X POST \ https://cloud.minapp.com/oserve/v1.3/cloud-function/test/debug/ \ -H "Authorization: Bearer cfb5912724dd7ff0b0c17683cc3074bb548bc7f4" \ -H 'Content-Type: application/json' \ -d '{ "data": {} }' ``` ```js var request = require("request"); var cloudFunctionName = ''; var options = { method: 'POST', url: 'https://cloud.minapp.com/oserve/v1.3/cloud-function/' + cloudFunctionName + '/debug/', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer 2323d124881bd3d63c9bb7845454f80a676b' }, body: { data: {} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); ``` ```php "exports.main = function functionName(event, callback) {\n callback(null, \"hello world\")\n}", 'remark'=> '你好，云函数' ) ); curl_setopt($ch, CURLOPT_HTTPHEADER, $header); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($ch, CURLOPT_POSTFIELDS, $payload); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); $response = curl_exec($ch); $err = curl_error($ch); curl_close($ch); if ($err) { echo "CURL Error #:" . $err; } else { echo $response; } ``` **返回示例** ```javascript { "audit_status": "approved", "created_at": 1537704381, "created_by": "", "function_code": "exports.main = function functionName(event, callback) {\n callback(null, \"hello world\")\n}", "id": 1105, "name": "come_from_open_api", "plan_circle": "P_FREE", "remark": "你好，云函数", "updated_at": 1537704381, "updated_by": "" } ``` **状态码说明** `201`: 创建成功。 `400`: 参数不合法：云函数名或代码为字段为空。 `401`: 未授权，请检查请求头中的 Authorization 字段是否正确。 ## 获取当前小程序的所有云函数 **接口地址** `GET https://cloud.minapp.com/oserve/v1.3/cloud-function/` **返回参数说明** | 参数 | 类型 | 说明 | | -------------- | ------- | --------------------------------- | | audit\_status | String | 可能的值： approved, rejected, waiting | | created\_by | String | 创建者昵称 | | function\_code | String | 云函数代码 | | id | Integer | 云函数 ID | | name | String | 云函数名 | | plan\_circle | String | 套餐类型 | | remark | String | 备注 | | updated\_at | Integer | 最近一次更新时间 | | updated\_by | String | 更新者昵称 | **代码示例** ``` curl -X GET \ https://cloud.minapp.com/oserve/v1.3/cloud-function/ \ -H 'Authorization: Bearer 2323d124881bd3d63c9bb78458252454f676b' ``` ```javascript var request = require("request"); var options = { method: 'GET', url: 'https://cloud.minapp.com/oserve/v1.3/cloud-function/', headers: { Authorization: 'Bearer 2323d124881bd3d6bb78458252454f80a676b' }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); ``` ```php "exports.main = function functionName(event, callback) {\n callback(null, \"hello world\")\n}", 'remark'=> '你好，云函数' ) ); curl_setopt($ch, CURLOPT_HTTPHEADER, $header); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH'); curl_setopt($ch, CURLOPT_POSTFIELDS, $payload); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true); $response = curl_exec($ch); $err = curl_error($ch); curl_close($ch); if ($err) { echo "CURL Error #:" . $err; } else { echo $response; } ``` **返回示例** ``` { "audit_status": "approved", "created_at": 1535903214, "created_by": "somebody", "function_code": "exports.main = function functionName(event, callback) {\n callback(null, \"hello world\")\n}", "id": 847, "name": "modify_from_open_api", "plan_circle": "P_FREE", "remark": "", "updated_at": 1537710962, "updated_by": "somebody" } ``` **状态码说明** `202`: 修改成功。 `400`: 参数不合法：云函数名或代码为空。 `401`: 未授权，请检查请求头中的 Authorization 字段是否正确。 `401`: 参数不合法：云函数名或代码为空 ## 删除一个云函数 **接口地址** `DELETE https://cloud.minapp.com/oserve/v1.3/cloud-function/:cloud-function-name/` 其中 `:cloud-function-name` 是云函数的名字。 **代码示例** ``` curl -X DELETE \ https://cloud.minapp.com/oserve/v1.3/cloud-function/test/ \ -H 'Authorization: Bearer 2323d124881bd3d63c9bb78458252454f676b' ``` ```js var request = require("request"); var cloudFunctionName = ''; var options = { method: 'DELETE', url: 'https://cloud.minapp.com/oserve/v1.3/cloud-function/' + cloudFunctionName + '/', headers: { Authorization: 'Bearer 2323d124881bd3d63c9bb784582524540a676b' }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(response.statusCode); }); ``` ```php