# 获取云函数
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getCloudFunctionList
通过本接口可以获取云函数列表,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/componenttcb/getscflist?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口仅支持第三方平台使用 component_access_token 自己调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 component_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| env | string | 是 | 环境ID |
| offset | number | 否 | 数据偏移量。默认值0 |
| limit | number | 否 | 返回数据长度。默认值20 |
| searchkey | string | 否 | 模糊匹配 functionName |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| total_count | number | 云函数个数 |
| functions | objarray | 云函数信息 |
# Res.functions(Array) Object Payload
云函数信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| mod_time | string | 修改时间 |
| add_time | string | 添加时间 |
| runtime | string | Nodejs8.9 |
| name | string | 名称 |
| status | string | 状态CreateFailed |
| status_reason | objarray | 原因 |
# Res.functions(Array).status_reasonObject Payload
Object Payload原因
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | string | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"env": "myttest-8gu57so0bd9f9e8a"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"total_count": 2,
"functions": [
{
"mod_time": "2021-07-29 15:04:19",
"add_time": "2021-07-29 15:04:19",
"runtime": "Nodejs8.9",
"name": "testfunc5",
"status": "CreateFailed",
"status_reason": [
{
"errcode": "ResourceNotFound.File",
"errmsg": "未找到函数执行入口文件,请确认代码包入口文件名和 handler 设置是否对应或代码压缩包是否正常。"
}
]
},
{
"mod_time": "2021-07-29 14:41:43",
"add_time": "2021-07-29 14:41:43",
"runtime": "Nodejs8.9",
"name": "testfunc4",
"status": "Active",
"status_reason": []
}
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
| 85088 | no qbase privilege | 该APP未开通云开发 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。