创建鸿蒙软总线
功能介绍
应用服务器可调用此接口新建鸿蒙软总线。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/harmony-soft-bus
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
bus_name |
否 |
String |
参数说明：鸿蒙软总线组名称，单个资源空间下不可重复。 取值范围：长度不超过64，只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。 |
|
group_id |
否 |
String |
参数说明：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 |
|
app_id |
否 |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的设备组归属到哪个资源空间下，否则创建的设备组将会归属到默认资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bus_id |
String |
鸿蒙软总线ID，用于唯一标识一个鸿蒙软总线，在创建鸿蒙软总线时由物联网平台分配。 |
|
bus_name |
String |
鸿蒙软总线名称，单个资源空间下不可重复。 |
|
group_id |
String |
设备组ID。 |
|
app_id |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的设备组归属到哪个资源空间下，否则创建的设备组将会归属到默认资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
status |
String |
鸿蒙软总线组信息同步状态，结果范围：Synchronized，Synchronizing，ToBeSynchronized
|
请求示例
POST https://{endpoint}/v5/iot/{project_id}/harmony-soft-bus
{
"bus_name" : "GroupA",
"group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
"app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka"
}
响应示例
状态码：201
Created
{
"bus_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
"bus_name" : "BusA",
"app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
"group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
"status" : "Synchronized"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
403 |
Forbidden |
错误码
请参见错误码。
