すべてのプロダクト
Search

このプロダクト

    IoT Platform:PubBroadcast

    ドキュメントセンター

    IoT Platform:PubBroadcast

    最終更新日:Apr 17, 2025

    プロダクトのオンラインデバイスにメッセージをブロードキャストします。すべてのオンラインデバイス、または特定のトピックをサブスクライブしているオンラインデバイスのみを指定できます。

    使用上の注意

    リクエスト で TopicFullName を設定して、メッセージをブロードキャストするデバイスを指定できます。詳細については、このトピックの TopicFullName パラメーターの説明をご参照ください。

    QPS 制限

    • 特定のトピックをサブスクライブしているオンラインデバイスにメッセージをブロードキャストするには、この操作をアカウントごとに 1 秒あたり最大 1 回呼び出すことができます。

    • プロダクトのすべてのオンラインデバイスにメッセージをブロードキャストするには、この操作をアカウントごとに 1 分あたり最大 1 回呼び出すことができます。

    説明

    Alibaba Cloud アカウントの Resource Access Management （RAM）ユーザーは、アカウントのクォータを共有します。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーター

    種類

    必須

    例

    説明

    Action

    String

    はい

    PubBroadcast

    実行する操作。値を PubBroadcast に設定します。

    MessageContent

    String

    はい

    aGVsbG93b3JsZA

    送信するメッセージの内容。メッセージのサイズは 64 KB を超えることはできません。

    メッセージの内容を生成するには、生のメッセージをバイナリデータに変換し、Base64 エンコーディングを実行します。

    説明

    IoT Platform は Base64 アルゴリズムを使用してデータをデコードし、デコードされたメッセージをデバイスに送信します。このようにして、デバイスは Base64 でエンコードされたデータをデコードする必要がありません。

    ProductKey

    String

    はい

    aldeji3*****

    デバイスが属するプロダクトの ProductKey。

    ProductKeyQueryProductList は、IoT Platform がプロダクトに発行する一意の識別子です。 IoT Platform コンソールで、または 操作を呼び出すことで、現在の Alibaba Cloud アカウント内のすべてのプロダクトに関する情報を表示できます。

    IotInstanceId

    String

    いいえ

    iot_instc_pu****_c*-v64********

    インスタンス ID。IoT Platform コンソールの インスタンス ID概要 ページで を表示できます。

    重要

    • インスタンスに ID がある場合は、このパラメーターを指定する必要があります。指定しないと、リクエストは失敗します。

    • インスタンスに対して [概要] ページまたは [ID] が生成されない場合は、このパラメーターを指定する必要はありません。

    詳細については、「概要」をご参照ください。

    TopicFullName

    String

    いいえ

    /broadcast/UPqSxj2vXXX/xxx

    トピック名。

    • このパラメーターを指定しない場合、メッセージは指定された ProductKey/sys/${productKey}/${deviceName}/broadcast/request/${MessageId}メッセージ ID を持つすべてのオンラインデバイスにプッシュされます。デバイスは、次の形式のブロードキャストトピックからメッセージを受信します。 変数は IoT Platform によって生成されます。

    • このパラメーターを指定すると、メッセージは、指定された ProductKey/broadcast/${productKey}/カスタムフィールド${productKey} ProductKey を持ち、指定されたトピックをサブスクライブしているデバイスにプッシュされます。次の構文を使用してブロードキャストトピックを指定する必要があります。 を、メッセージを受信するデバイスの に置き換えます。カスタムフィールドには、ビジネス要件に基づいて値を指定できます。

    説明

    • デバイスを開発する場合、ブロードキャストトピックを定義するコードを記述するだけで済みます。 IoT Platform コンソールでトピックを作成する必要はありません。

    • 最大 1,000 台のデバイスがブロードキャストトピックをサブスクライブできます。デバイス数が制限を超える場合は、デバイスをグループに分割できます。たとえば、5,000 台のデバイスを 5 つのグループに分割できます。各グループには 1,000 台のデバイスが含まれています。この場合、PubBroadcast 操作を 5 回呼び出す必要があります。操作を呼び出すたびに、ブロードキャストトピックのカスタムフィールドを group1、group2、group3、group4、group5 に設定します。各デバイスグループが指定されたブロードキャストトピックをサブスクライブしていることを確認してください。

      上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通パラメーター」をご参照ください。

      レスポンスパラメーター

      パラメーター

      種類

      例

      説明

      Code

      String

      iot.system.SystemException

      リクエストが失敗した場合に返されるエラーコード。詳細については、このトピックのエラーコードセクションをご参照ください。

      ErrorMessage

      String

      システム例外が発生しました。

      リクエストが失敗した場合に返されるエラーメッセージ。

      MessageId

      Long

      1234291569964771840

      メッセージの送信時に IoT Platform によって生成されるメッセージ ID。

      RequestId

      String

      BB71E443-4447-4024-A000-EDE09922891E

      リクエスト ID。

      Success

      Boolean

      true

      リクエストが成功したかどうかを示します。有効な値：

      • true

      • false

      例

      リクエストの例

      https://iot.cn-shanghai.aliyuncs.com/?Action=PubBroadcast
&ProductKey=al**********
&TopicFullName=/broadcast/UPq****/xxx
&MessageContent=aGVsbG93b3JsZA
&<共通リクエストパラメーター>

      成功レスポンスの例

      XML 形式

      <PubBroadcastResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <MessageId>1234291569964771840</MessageId>
        <Success>true</Success>
  </PubBroadcastResponse>

      JSON 形式

      {
      "RequestId":"BB71E443-4447-4024-A000-EDE09922891E",
      "MessageId":1234291569964771840,
      "Success":true
}

      エラーコード

      エラーコードのリストについては、「サービスエラーコード」をご参照ください。