文档首页/ Astro轻应用 AstroZero/ API参考/ API/ 脚本/ 运行脚本
更新时间：2024-07-18 GMT+08:00
查看PDF
分享

运行脚本

功能介绍

运行脚本，该接口是同步接口（同步接口是指调用后，会等待函数执行结束后，才返回结果）。满足输入参数条件后执行该脚本，不会在控制台打印出日志，但会输出运行结果。

在脚本保存成功和输入参数正确的情况下，可以运行该脚本，但该接口目前已很少使用（可以用custom API运行脚本）。

URI

POST AstroZero域名/u-route/baas/script/v1.0/run/{scriptName}{?version=1.0.1}

表1 参数说明

参数

是否必选

参数类型

描述

scriptName

是

String

参数解释：

脚本的名称，请参考登录应用设计器中操作，进入应用设计器，在“逻辑 > 脚本”列表中查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

version

否

String

参数解释：

脚本的版本号，表示运行具体版本号对应的脚本，不配置表示运行最新版本的脚本。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

请求体中的参数均为用户自定义的，为该脚本中定义的输入参数，具体参数视脚本而定。

响应参数

表2 响应参数

参数

参数类型

描述

resCode

String

参数解释：

返回码。

取值范围：

如果返回“0”代表请求成功，其他错误码说明请参考错误码。

resMsg

String

参数解释：

返回消息。

取值范围：

如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。

result

Object

参数解释：

在成功请求时，会有内容返回。

请求示例

运行脚本，假设脚本“命名空间__editEquipment”有输入参数equipment、name、命名空间__equipmentSN__CST。

POST https://AstroZero域名/u-route/baas/script/v1.0/run/命名空间__editEquipment?version=1.0.1  
 
{ 
    "equipment": { 
        "name": "某某园区A栋1单元16号", 
        "命名空间__equipmentSN__CST": "3217890020" 
    } 
}

响应示例

{
    "resCode": "0",
    "resMsg": "成功",
    "result": {
        "value": {
            "equipmentId": "c9uK000000iYJt41oj8S"
        },
        "log": ""
    }
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： 脚本

相关文档