Create a HarmonyOS Soft Bus

Function

This API is used by an application to create a HarmonyOS soft bus.

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:create	Write	-	g:EnterpriseProjectId	-	-

URI

POST /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.

Request Parameters

**Table 2** 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
bus_name	No	String	Parameter description: Name of the HarmonyOS soft bus group, which must be unique in a resource space. Value: The value can contain a maximum of 64 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed.
group_id	No	String	Parameter description: device group ID. The ID is unique and is allocated by the platform during device group creation.
app_id	No	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.

Response Parameters

Status code: 201

**Table 4** Response body parameters
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

Example Requests

POST https://{endpoint}/v5/iot/{project_id}/harmony-soft-bus

{
  "bus_name" : "GroupA",
  "group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
  "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka"
}

Example Responses

Status code: 201

Created

{
  "bus_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
  "bus_name" : "BusA",
  "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
  "group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
  "status" : "Synchronized"
}