查询鸿蒙软总线列表
功能介绍
应用服务器可调用此接口查询鸿蒙软总线列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v5/iot/{project_id}/harmony-soft-bus
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
参数说明：分页查询时每页显示的记录数。 取值范围：1-50的整数，默认值为10。 |
|
marker |
否 |
String |
参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。 |
|
offset |
否 |
Integer |
参数说明：表示从marker后偏移offset条记录开始查询。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数，默认为0。 |
|
group_id |
否 |
String |
参数说明：设备组ID，用于唯一标识一个设备组，在创建设备组时由物联网平台分配。 取值范围：长度不超过36，十六进制字符串和连接符（-）的组合。 |
|
app_id |
否 |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的产品列表，不携带该参数则会查询该用户下所有产品列表。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
harmony_soft_buses |
Array of HarmonySoftBusResponseDTO objects |
设备组信息列表。 |
|
page |
Page object |
查询结果的分页信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bus_id |
String |
鸿蒙软总线ID，用于唯一标识一个鸿蒙软总线，在创建鸿蒙软总线时由物联网平台分配。 |
|
bus_name |
String |
鸿蒙软总线名称，单个资源空间下不可重复。 |
|
group_id |
String |
设备组ID。 |
|
app_id |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的设备组归属到哪个资源空间下，否则创建的设备组将会归属到默认资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
status |
String |
鸿蒙软总线组信息同步状态，结果范围：Synchronized，Synchronizing，ToBeSynchronized
|
请求示例
GET https://{endpoint}/v5/iot/{project_id}/device-group/harmony-soft-bus?group_id=04ed32dc1b0025b52fe3c01a27c2babc&app_id=jeQDJQZltU8iKgFFoW060F5SGZka
响应示例
状态码：200
OK
{
"harmony_soft_buses" : [ {
"bus_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
"bus_name" : "BusA",
"app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
"group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
"status" : "Synchronized"
} ],
"page" : {
"count" : 10,
"marker" : "5c90fa7d3c4e4405e8525079"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
