HTTP请求节点是创建API的开始节点,通过该节点配置API的请求参数。每个API有且仅有一个HTTP请求节点,中间逻辑节点可根据业务需要选择其他功能节点,但必须以HTTP返回节点作为终止节点。开发的API可被外部调用,可用于Web可视化开发。

节点配置

配置项 说明
节点名称 设置节点名称。支持中文汉字、英文字母、数字和下划线(_)。长度不超过30个字符。
Action 设置调用API时,参数Action的值。可包含英文大小写字母和数字。
新增参数 根据业务需要,设置调用API的请求参数。参数设置包含:
  • 参数名称:支持英文大小写字母、数字和下划线(_),且必须以英文字母开头。长度不超过50个字符。
  • 类型:参数的数据类型,支持:String、Int、Long、Float、Double、Boolean。
  • 是否必填:该参数是否为必传参数。若选择为是,IoT Studio平台会校验API调用请求中是否包含了此参数,若请求中没有此参数或参数类型错误,则拒绝请求。
  • 默认值(可选):为参数设置默认值。如果该参数为非必填,调用API时,若没有传入该参数的值,则使用默认值。
  • 描述:描述参数的用途、使用注意事项等。


节点输出

调用成功时的输出数据格式示例如下:

{
        "code": 200,
        "data": {
            "入参名1": 参数值1,
            "入参名2": 参数值2
        },
        "message": "success",
        "localizedMsg": "成功"

}

调用失败的输出数据,请查看节点日志。

后续节点使用该节点输出数据

如果该服务的其他节点需要调用请求参数值,可以通过query访问具体参数,或者将某个请求参数选择为后续节点的输入源。

  • 通过query访问。

    在配置后续节点,如脚本节点或钉钉机器人节点,编辑内容时,可使用query.入参名结构调用API的入参值。

    钉钉机器人等JSON输入框采用{{query.入参名}}的格式。示例如下:



    脚本等代码输入框,直接采用query.入参名格式。示例如下:



  • 通过配置项访问。

    在配置后续节点时,如条件判断节点或路径选择节点,选择数据源为HTTP请求中的某个请求参数。