云函数
触发云函数
接口地址
POST https://cloud.minapp.com/userve/v1.3/cloud-function/:cloud-function-name/job/
其中 :cloud-function-name
是云函数的名字。
请求参数说明
Content-Type: Content-Type: application/json
data
Object
是
传递给云函数的参数,如果没有需要提供一个空对象
sync
Bool
否
是否等待返回函数执行结果,默认为 true。同步与异步云函数有不同的超时时间,同步云函数为 5 秒,而异步云函数为 5 分钟(300 秒)
返回参数说明
sync 为 true 时:
code
Number
code 为 0 时表示成功执行云函数,否则为执行云函数失败
data
由云函数返回的数据类型决定
函数通过 callback 返回的数据
error
Object
返回的错误信息,成功则返回空对象
sync 为 false 时:
status
String
默认为 'ok'
获取某云函数的任务记录
接口地址
GET https://cloud.minapp.com/userve/v1.3/cloud-function/:cloud-function-name/job/
其中 :cloud-function-name
是云函数的名字。
参数说明
source
String
否
云函数任务来源,可选值:sdk, open_api, cloud_function, flex_schema, wechat_pay_success, alipay_pay_success, qpay_success, baidu_pay_success, timer, file_operation, user_dash, incoming_webhook, wechat_message, user_activity
status
String
否
云函数任务状态,可选值:waiting, executing, fulfilled, schedule_failed, execution_rejected, deadline_exceeded, execution_failed
service_type
String
否
云函数同步类型,可选值:time_sensitive, batch
返回参数
id
Integer
任务 ID
created_at
Float
创建时间
finished_at
Float
完成时间
mem_usage
Integer
内存用量
service_type
String
可能的值:time_sensitive, batch
source
String
任务来源
status
String
任务状态
user_log_url
String
日志地址
返回示例
状态码说明
200
: 成功。
400
: 参数错误。
新建云函数
接口地址
POST https://cloud.minapp.com/userve/v1.3/cloud-function/
请求参数说明
name
String
是
云函数名,不能为空字符串
function_code
String
是
云函数代码,不能为空字符串
remark
String
否
备注
返回参数说明
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
更新者昵称
created_at
Integer
创建时间
状态码说明
201
: 创建成功。
400
: 参数不合法:云函数名或代码为字段为空。
获取当前小程序的所有云函数
接口地址
GET https://cloud.minapp.com/userve/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
更新者昵称
created_at
Integer
创建时间
返回示例
状态码说明
200
: 成功。
获取云函数详细信息
接口地址
GET https://cloud.minapp.com/userve/v1.3/cloud-function/:cloud-function-name/
其中 :cloud-function-name
为云函数的名字。
返回参数说明
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
更新者昵称
created_at
Integer
创建时间
返回示例
状态码说明
200
: 成功。
404
: 云函数不存在。
修改云函数
接口地址
PATCH https://cloud.minapp.com/userve/v1.3/cloud-function/:cloud-function-name/
其中 :cloud-function-name
为云函数名字。
请求参数说明
name
String
否
云函数名,不能为空字符串
function_code
String
否
云函数代码,不能为空字符串
plan_circle
String
否
套餐类型,可能的值:P_FREE(128 MB 内存), P_PERSONAL(256 MB 内存)
remark
String
否
备注
返回参数说明
audit_status
String
可能的值: approved, rejected, waiting
created_by
String
创建者昵称
function_code
String
云函数代码
id
Integer
云函数 ID
name
String
云函数名
plan_circle
String
套餐类型,可能的值:P_FREE(128 MB 内存), P_PERSONAL(256 MB 内存)
remark
String
备注
updated_at
Integer
最近一次更新时间
updated_by
String
更新者昵称
created_at
Integer
创建时间
返回示例
状态码说明
202
: 修改成功。
400
: 参数不合法:云函数名或代码为空。
删除一个云函数
接口地址
DELETE https://cloud.minapp.com/userve/v1.3/cloud-function/:cloud-function-name/
其中 :cloud-function-name
是云函数的名字。
状态码说明
204
: 删除成功。
404
: 没有找到对应的云函数。
Last updated
Was this helpful?