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

前提条件

已完成业务服务的创建。详细内容请参见创建业务服务

节点配置

在业务逻辑开发编辑页面的节点 > 触发列表中,拖拽HTTP请求节点到中间画布并进行配置,如图所示。

HTTP请求
配置项 说明
节点名称 支持中文汉字、英文字母、数字和下划线(_)。长度不超过30个字符。
Action 设置调用API时,参数Action的值。可包含英文大小写字母和数字。
账号鉴权 选中后,开启账号鉴权。只有登录账号后才能调用该服务,且需要与IoT Studio的Web可视化应用配合使用。有关账号的详细内容请参见账号鉴权
访问限制 选中后,需要管理员在运营后台配置可调用该服务的角色,详细内容请参见账号
入参配置 根据业务需要,设置调用API的请求参数。单击+添加入参,参数设置包含:
  • 参数名称:支持英文大小写字母、数字和下划线(_),且必须以英文字母开头。长度不超过50个字符。
  • 类型:参数的数据类型,支持String、Int、Long、Float、Double、Boolean。
  • 是否必填:该参数是否为必传参数。若选择必填项,IoT Studio平台会校验API调用请求中是否包含了此参数,若请求中没有此参数或参数类型错误,则拒绝请求。
  • 默认值(可选):为参数设置默认值。如果该参数为非必填,调用API时,若没有传入该参数的值,则使用默认值。
  • 描述:输入参数的用途、使用注意事项等。

节点输出

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

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

}

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

该节点输出数据的使用方法

配置后续节点时,可通过以下方式调用输出数据中某字段的值来使用。

  • 以query方式调用具体的参数字段。

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

    • 钉钉机器人消息示例
    • 脚本节点代码示例
  • 将本节点选择为后续节点输入源。

    例如条件判断或路径选择节点,选择数据源为HTTP请求中的某个请求参数。

    后续节点

API调用方法

发布HTTP业务服务后,在业务逻辑开发工作台,单击左侧导航栏的服务调用设置按钮设置。根据实际需求在API调用方式页签的请求示例中,获取调用方法。

说明 您可单击域名管理页签,根据页面提示自定义API的访问域名。
请求示例