更新时间:2024-10-23 GMT+08:00

创建网桥

功能介绍

应用服务器可调用此接口在物联网平台创建一个网桥,仅在创建后的网桥才可以接入物联网平台。

  • 一个实例最多支持20个网桥。

  • 标准版实例、企业版实例支持该接口调用,基础版不支持。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/bridges

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情

表3 请求Body参数

参数

是否必选

参数类型

描述

bridge_name

String

网桥名称。取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

bridge_id

String

网桥ID。取值范围:长度不超过36,只允许字母、数字、_-字符的组合。

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

bridge_id

String

网桥ID,用于唯一标识一个网桥。在注册网桥时直接指定,或者由物联网平台分配获得。

bridge_name

String

网桥名称。

auth_info

BridgeAuthInfo object

网桥鉴权信息

create_time

String

在物联网平台注册网桥的时间。格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

表5 BridgeAuthInfo

参数

参数类型

描述

auth_type

String

鉴权类型。当前支持密钥认证接入(SECRET)。使用密钥认证接入方式(SECRET)填写secret字段,不填写auth_type默认为密钥认证接入方式(SECRET)。

secret

String

网桥密钥,认证类型使用密钥认证接入(SECRET)可填写该字段。

请求示例

POST https://{endpoint}/v5/iot/{project_id}/bridges

{
  "bridge_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
  "bridge_name" : "dianabridge"
}

响应示例

状态码: 201

Created

{
  "bridge_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
  "bridge_name" : "dianabridge",
  "auth_info" : {
    "auth_type" : "SECRET",
    "secret" : "3b935******dc3c"
  },
  "create_time" : "20190303T081011Z"
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码