Query the HarmonyOS Soft Bus List

Function

This API is used by an application to query the HarmonyOS soft bus list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:harmonysoftbus:queryList	List	-	g:EnterpriseProjectId	-	-

URI

GET /v5/iot/{project_id}/harmony-soft-bus

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Parameter description: number of records to display on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value must contain 24 hexadecimal characters. The default value is ffffffffffffffffffffffff.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0.
group_id	No	String	Parameter description: device group ID. The ID is unique and is allocated by the platform during device group creation. Value: The value can contain a maximum of 36 characters, including hexadecimal strings and hyphens (-).
app_id	No	String	Parameter description: resource space ID. This parameter is optional. If you have multiple resource spaces, you can specify this parameter to query products in the specified resource space. If this parameter is not carried, products in all resource spaces are queried. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Instance-Id	No	String	Parameter description: instance ID. This parameter is required only when the API is called from the management plane in the physical multi-tenant scenario. Log in to the IoTDA console and choose Overview in the navigation pane to check the instance ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
harmony_soft_buses	Array of HarmonySoftBusResponseDTO objects	Device group information list.
page	Page object	Pagination information of the query results.

**Table 5** HarmonySoftBusResponseDTO
Parameter	Type	Description
bus_id	String	Unique ID of a HarmonyOS soft bus, which is allocated by the IoT platform when the soft bus is created.
bus_name	String	HarmonyOS soft bus name, which must be unique in a single resource space.
group_id	String	ID of a device group.
app_id	String	Parameter description: resource space ID. This parameter is optional. If you have multiple resource spaces, you can use this parameter to specify the resource space to which the device group to create will belong. If this parameter is not specified, the device group to create will belong to the default resource space. Value: The value can contain up to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
status	String	HarmonyOS soft bus group information synchronization status. Synchronized Synchronizing ToBeSynchronized

**Table 6** Page
Parameter	Type	Description
count	Long	Total number of records that meet the filter criteria.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

GET https://{endpoint}/v5/iot/{project_id}/device-group/harmony-soft-bus?group_id=04ed32dc1b0025b52fe3c01a27c2babc&app_id=jeQDJQZltU8iKgFFoW060F5SGZka

Example Responses

Status code: 200

{
  "harmony_soft_buses" : [ {
    "bus_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
    "bus_name" : "BusA",
    "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
    "group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
    "status" : "Synchronized"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}