Updated on 2026-01-29 GMT+08:00

Synchronize the HarmonyOS Soft Bus

Function

This API is used by an application to synchronize HarmonyOS soft bus information to devices in the group.

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:sync

    Write

    -

    g:EnterpriseProjectId

    -

    -

URI

POST /v5/iot/{project_id}/harmony-soft-bus/{bus_id}/sync

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description: project ID. For details, see Obtaining a Project ID.

bus_id

Yes

String

Parameter description: Unique ID of a HarmonyOS soft bus, which is allocated by the IoT platform when the soft bus is created.

Value: The value can contain a maximum of 36 characters, including hexadecimal strings and hyphens (-).

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.

Response Parameters

Status code: 200

OK

None

Example Requests

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

Example Responses

None

Status Codes

Status Code

Description

200

OK

404

Not Found

403

Forbidden

Error Codes

See Error Codes.